@azure/arm-redhatopenshift package

インターフェイス

APIServerProfile

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

AzureRedHatOpenShiftClientOptionalParams

クライアントの省略可能なパラメーター。

CloudError

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

CloudErrorBody

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

ClusterProfile

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

ConsoleProfile

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

Display

ディスプレイは操作の詳細表示を表します。

EffectiveOutboundIP

EffectiveOutboundIPは、クラスタのパブリックロードバランサーの有効なアウトバウンドIPリソースを表します。

IngressProfile

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

LoadBalancerProfile

LoadBalancerProfileはクラスタのパブリックロードバランサーのプロファイルを表します。

ManagedOutboundIPs

ManagedOutboundIPsは、クラスタのパブリックロードバウンサー向けに望ましい管理されるアウトバウンドIPを表します。

ManagedServiceIdentity

マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID)

MasterProfile

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

NetworkProfile

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

OpenShiftCluster

OpenShiftClusterはAzure Red Hat OpenShiftクラスターを表しています。

OpenShiftClusterAdminKubeconfig

OpenShiftClusterAdminKubeconfigはOpenShiftクラスタのadmin kubeconfigを表します。

OpenShiftClusterCredentials

OpenShiftClusterCredentialsはOpenShiftクラスタの認証情報を表します。

OpenShiftClusterProperties

OpenShiftClusterPropertiesはOpenShiftクラスタのプロパティを表します。

OpenShiftClusterUpdate

OpenShiftClusterはAzure Red Hat OpenShiftクラスターを表しています。

OpenShiftClustersCreateOrUpdateOptionalParams

省略可能なパラメーター。

OpenShiftClustersDeleteOptionalParams

省略可能なパラメーター。

OpenShiftClustersGetOptionalParams

省略可能なパラメーター。

OpenShiftClustersListAdminCredentialsOptionalParams

省略可能なパラメーター。

OpenShiftClustersListByResourceGroupOptionalParams

省略可能なパラメーター。

OpenShiftClustersListCredentialsOptionalParams

省略可能なパラメーター。

OpenShiftClustersListOptionalParams

省略可能なパラメーター。

OpenShiftClustersOperations

OpenShiftClustersの操作を表すインターフェース。

OpenShiftClustersUpdateOptionalParams

省略可能なパラメーター。

OpenShiftVersion

OpenShiftVersionはインストール可能なOpenShiftバージョンを表しています。

OpenShiftVersionProperties

OpenShiftVersionPropertiesはOpenShiftVersionのプロパティを表します。

OpenShiftVersionsGetOptionalParams

省略可能なパラメーター。

OpenShiftVersionsListOptionalParams

省略可能なパラメーター。

OpenShiftVersionsOperations

OpenShiftVersions操作を表すインターフェース。

Operation

OperationはRPオペレーションを表します。

OperationsListOptionalParams

省略可能なパラメーター。

OperationsOperations

操作操作を表すインターフェイス。

PageSettings

byPage メソッドのオプション

PagedAsyncIterableIterator

完了とページごとの非同期反復を可能にするインターフェイス。

PlatformWorkloadIdentity

PlatformWorkloadIdentityは、単一のワークロードIDを表す情報を格納します。

PlatformWorkloadIdentityProfile

PlatformWorkloadIdentityProfileは、ワークロード識別クラスターに特有のすべての情報をカプセル化しています。

PlatformWorkloadIdentityRole

PlatformWorkloadIdentityRoleは、特定のOCPオペレーターから、そのオペレーターに対応する管理IDに割り当てられるべき組み込みロールへのマッピングを表します。

PlatformWorkloadIdentityRoleSet

PlatformWorkloadIdentityRoleSetは、OCPオペレータの名前から、特定のOCPバージョンに対してそれらのオペレータに対応する管理IDに割り当てられるべき組み込みロールへのマッピングを表します。

PlatformWorkloadIdentityRoleSetGetOptionalParams

省略可能なパラメーター。

PlatformWorkloadIdentityRoleSetOperations

PlatformWorkloadIdentityRoleSet 操作を表すインターフェース。

PlatformWorkloadIdentityRoleSetProperties

PlatformWorkloadIdentityRoleSetPropertiesは、PlatformWorkloadIdentityRoleSetリソースのプロパティを表します。

PlatformWorkloadIdentityRoleSetsListOptionalParams

省略可能なパラメーター。

PlatformWorkloadIdentityRoleSetsOperations

プラットフォームWorkloadIdentityRoleSet 操作を表すインターフェース。

ProxyResource

Azure Resource Manager プロキシ リソースのリソース モデル定義。 タグと場所はありません

Resource

すべての Azure Resource Manager リソースの応答で返される共通フィールド

RestorePollerOptions
ServicePrincipalProfile

ServicePrincipalProfileはサービスプリンシパルプロファイルを表します。

SimplePollerLike

実行時間の長い操作をポーリングするために使用できる単純なポーリングツール。

SystemData

リソースの作成と最後の変更に関連するメタデータ。

TrackedResource

Azure Resource Manager のリソース モデル定義は、"タグ" と "場所" を持つ最上位リソースを追跡しました

UserAssignedIdentity

ユーザー割り当て ID プロパティ

WorkerProfile

ワーカープロファイルはワーカープロファイルを表します。

型エイリアス

AzureSupportedClouds

文字列リテラル型としてのクラウド設定でサポートされている値

ContinuablePage

結果のページを記述するインターフェイス。

CreatedByType

リソースを作成したエンティティの種類。
KnownCreatedByType を CreatedByType と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

ユーザー: エンティティはユーザーによって作成されました。
アプリケーション: エンティティはアプリケーションによって作成されました。
ManagedIdentity: エンティティはマネージド ID によって作成されました。
キー: エンティティはキーによって作成されました。

EncryptionAtHost

EncryptionAtHostはホスト状態での暗号化を表します
KnownEncryptionAtHost はEncryptionAtHostと互換的に使用可能で、この列挙はサービスがサポートする既知の値を示します。

サービスでサポートされている既知の値

無効:無効化
有効: 有効

FipsValidatedModules

FipsValidatedModulesはFIPSが使用されているかどうかを判断します。
KnownFipsValidatedModules はFipsValidatedModulesと同義使用可能で、この列挙はサービスがサポートする既知の値を含む。

サービスでサポートされている既知の値

無効:無効化
有効: 有効

ManagedServiceIdentityType

マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
KnownManagedServiceIdentityType ManagedServiceIdentityType と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

なし: マネージド ID はありません。
SystemAssigned: システム割り当てマネージド ID。
UserAssigned: ユーザーが割り当てたマネージド ID。
SystemAssigned、UserAssigned: システム割り当てマネージド ID とユーザー割り当てマネージド ID。

OutboundType

クラスタのインターネットへのエグレスを提供するために使われたアウトバウンドルーティング戦略。
KnownOutboundType を OutboundType と同じ意味で使用できる 、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

ロードバランサー:ロードバランサー
UserDefinedRouting: UserDefinedRouting

PreconfiguredNSG

PreconfiguredNSGは、顧客がサブネットに付随する自社のNSGを使いたいかどうかを示します
KnownPreconfiguredNSG はPreconfiguredNSGと同義で使用可能で、このenumはサービスがサポートする既知の値を含む。

サービスでサポートされている既知の値

無効:無効化
有効: 有効

ProvisioningState

ProvisioningStateはプロビジョニング状態を表します。
KnownProvisioningState ProvisioningState と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

Admin更新中:Admin更新中
キャンセル:キャンセル
作成:作成
削除: 削除
失敗: 失敗
成功:成功
更新:更新中

Visibility

可視性は可視性を表します。
KnownVisibility Visibility と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

プライベート:プライベート
パブリック:パブリック

列挙型

AzureClouds

Azure クラウド環境を記述する列挙型。

KnownCreatedByType

リソースを作成したエンティティの種類。

KnownEncryptionAtHost

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

KnownFipsValidatedModules

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

KnownManagedServiceIdentityType

マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。

KnownOutboundType

クラスタのインターネットへのエグレスを提供するために使われたアウトバウンドルーティング戦略。

KnownPreconfiguredNSG

PreconfiguredNSGは、顧客がサブネットに付随する自社のNSGを使いたいかどうかを示します

KnownProvisioningState

ProvisioningStateはプロビジョニング状態を表します。

KnownVersions

使用可能な API バージョン。

KnownVisibility

可視性は可視性を表します。

関数

isRestError(unknown)

RestError の Typeguard

restorePoller<TResponse, TResult>(AzureRedHatOpenShiftClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

別のポーラーのシリアル化された状態からポーリングャーを作成します。 これは、別のホストに投票者を作成する場合や、元のホストがスコープ内にない後にポーリングャーを構築する必要がある場合に便利です。

変数

RestError

失敗したパイプライン要求のカスタム エラーの種類。

関数の詳細

isRestError(unknown)

RestError の Typeguard

function isRestError(e: unknown): e

パラメーター

e

unknown

catch 句によってキャッチされる何か。

返品

e

restorePoller<TResponse, TResult>(AzureRedHatOpenShiftClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

別のポーラーのシリアル化された状態からポーリングャーを作成します。 これは、別のホストに投票者を作成する場合や、元のホストがスコープ内にない後にポーリングャーを構築する必要がある場合に便利です。

function restorePoller<TResponse, TResult>(client: AzureRedHatOpenShiftClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

パラメーター

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

返品

PollerLike<OperationState<TResult>, TResult>

変数の詳細

RestError

失敗したパイプライン要求のカスタム エラーの種類。

RestError: RestErrorConstructor