@azure/arm-containerservicefleet package

クラス

ContainerServiceFleetClient

インターフェイス

APIServerAccessProfile

フリート ハブ API サーバーのアクセス プロファイル。

AgentProfile

フリート ハブのエージェント プロファイル。

ContainerServiceFleetClientOptionalParams

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

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API に対する一般的なエラー応答 (これは、OData エラー応答形式にも従います)。

Fleet

フリート リソース。

FleetCredentialResult

1 つの資格情報の結果項目。

FleetCredentialResults

資格情報の結果の応答。

FleetHubProfile

FleetHubProfile によってフリート ハブが構成されます。

FleetListResult

フリートリスト操作の応答。

FleetMember

フリートのメンバー。 これには、Azure 上の既存の Kubernetes クラスターへの参照が含まれています。

FleetMemberListResult

FleetMember リスト操作の応答。

FleetMemberUpdate

FleetMember の更新操作に使用される型。

FleetMembers

FleetMembers を表すインターフェイス。

FleetMembersCreateHeaders

FleetMembers_create操作のヘッダーを定義します。

FleetMembersCreateOptionalParams

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

FleetMembersDeleteHeaders

FleetMembers_delete操作のヘッダーを定義します。

FleetMembersDeleteOptionalParams

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

FleetMembersGetOptionalParams

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

FleetMembersListByFleetNextOptionalParams

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

FleetMembersListByFleetOptionalParams

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

FleetMembersUpdateHeaders

FleetMembers_update操作のヘッダーを定義します。

FleetMembersUpdateOptionalParams

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

FleetPatch

パッチを適用できるフリートのプロパティ。

FleetUpdateStrategies

FleetUpdateStrategies を表すインターフェイス。

FleetUpdateStrategiesCreateOrUpdateHeaders

FleetUpdateStrategies_createOrUpdate操作のヘッダーを定義します。

FleetUpdateStrategiesCreateOrUpdateOptionalParams

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

FleetUpdateStrategiesDeleteHeaders

FleetUpdateStrategies_delete操作のヘッダーを定義します。

FleetUpdateStrategiesDeleteOptionalParams

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

FleetUpdateStrategiesGetOptionalParams

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

FleetUpdateStrategiesListByFleetNextOptionalParams

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

FleetUpdateStrategiesListByFleetOptionalParams

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

FleetUpdateStrategy

フリートのメンバー間で更新操作を実行するマルチステージ プロセスを定義します。

FleetUpdateStrategyListResult

FleetUpdateStrategy リスト操作の応答。

Fleets

フリートを表すインターフェイス。

FleetsCreateOrUpdateHeaders

Fleets_createOrUpdate操作のヘッダーを定義します。

FleetsCreateOrUpdateOptionalParams

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

FleetsDeleteHeaders

Fleets_delete操作のヘッダーを定義します。

FleetsDeleteOptionalParams

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

FleetsGetOptionalParams

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

FleetsListByResourceGroupNextOptionalParams

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

FleetsListByResourceGroupOptionalParams

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

FleetsListBySubscriptionNextOptionalParams

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

FleetsListBySubscriptionOptionalParams

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

FleetsListCredentialsOptionalParams

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

FleetsUpdateHeaders

Fleets_update操作のヘッダーを定義します。

FleetsUpdateOptionalParams

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

ManagedClusterUpdate

ManagedClusters に適用される更新プログラム。

ManagedClusterUpgradeSpec

ManagedCluster に適用するアップグレード。

ManagedServiceIdentity

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

MemberUpdateStatus

メンバー更新操作の状態。

NodeImageSelection

更新の実行でターゲット ノードに適用されるノード イメージのアップグレード。

NodeImageSelectionStatus

更新プログラムの実行に関するノード イメージのアップグレード 仕様。

NodeImageVersion

ノード アップグレード イメージのバージョン。

Operation

リソース プロバイダー操作 API から返される REST API 操作の詳細

OperationDisplay

この特定の操作のローカライズされた表示情報。

OperationListResult

Azure リソース プロバイダーでサポートされている REST API 操作の一覧。 これには、次の結果セットを取得するための URL リンクが含まれています。

Operations

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

OperationsListNextOptionalParams

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

OperationsListOptionalParams

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

ProxyResource

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

Resource

すべての Azure Resource Manager リソースの応答で返される一般的なフィールド

SkipProperties

複数のスキップ要求を含むスキップ操作のプロパティ。

SkipTarget

単一のスキップ要求の定義。

SystemData

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

TrackedResource

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

UpdateGroup

更新するグループ。

UpdateGroupStatus

UpdateGroup の状態。

UpdateRun

フリートのメンバー間で更新操作を実行するマルチステージ プロセス。

UpdateRunListResult

UpdateRun リスト操作の応答。

UpdateRunStatus

UpdateRun の状態。

UpdateRunStrategy

ステージとグループを使用してクラスターの更新シーケンスを定義します。

実行内のステージは、順番に順番に実行されます。 ステージ内のグループは並列で実行されます。 グループ内のメンバー クラスターは、順番に更新されます。

有効な戦略には、ステージ内またはステージ間で重複するグループが含まれています。

UpdateRuns

UpdateRuns を表すインターフェイス。

UpdateRunsCreateOrUpdateHeaders

UpdateRuns_createOrUpdate操作のヘッダーを定義します。

UpdateRunsCreateOrUpdateOptionalParams

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

UpdateRunsDeleteHeaders

UpdateRuns_delete操作のヘッダーを定義します。

UpdateRunsDeleteOptionalParams

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

UpdateRunsGetOptionalParams

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

UpdateRunsListByFleetNextOptionalParams

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

UpdateRunsListByFleetOptionalParams

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

UpdateRunsSkipHeaders

UpdateRuns_skip操作のヘッダーを定義します。

UpdateRunsSkipOptionalParams

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

UpdateRunsStartHeaders

UpdateRuns_start操作のヘッダーを定義します。

UpdateRunsStartOptionalParams

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

UpdateRunsStopHeaders

UpdateRuns_stop操作のヘッダーを定義します。

UpdateRunsStopOptionalParams

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

UpdateStage

次のステージを開始する前に、更新するグループと実行する手順 (期間を待つなど) を含むステージを定義します。

UpdateStageStatus

UpdateStage の状態。

UpdateStatus

操作または操作のグループの状態。

UserAssignedIdentity

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

WaitStatus

待機時間の状態。

型エイリアス

ActionType

ActionType の値を定義します。
KnownActionType は ActionType と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

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

内部

CreatedByType

CreatedByType の値を定義します。
KnownCreatedByType は CreatedByType と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

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

User
Application
ManagedIdentity
キー

FleetMemberProvisioningState

FleetMemberProvisioningState の値を定義します。
KnownFleetMemberProvisioningState は FleetMemberProvisioningState と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

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

成功: リソースが作成されました。
失敗: リソースの作成に失敗しました。
キャンセル済み: リソースの作成が取り消されました。
参加: フリートに参加するメンバーのプロビジョニング状態。
退出: フリートを離れるメンバーのプロビジョニング状態。
更新中: 更新されるメンバーのプロビジョニング状態。

FleetMembersCreateResponse

作成操作の応答データが含まれます。

FleetMembersGetResponse

get 操作の応答データが含まれます。

FleetMembersListByFleetNextResponse

listByFleetNext 操作の応答データを格納します。

FleetMembersListByFleetResponse

listByFleet 操作の応答データが含まれます。

FleetMembersUpdateResponse

更新操作の応答データが含まれます。

FleetProvisioningState

FleetProvisioningState の値を定義します。
KnownFleetProvisioningState は FleetProvisioningState と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

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

成功: リソースが作成されました。
失敗: リソースの作成に失敗しました。
キャンセル済み: リソースの作成が取り消されました。
作成中: 作成されるフリートのプロビジョニング状態。
更新中: 更新されるフリートのプロビジョニング状態。
削除中: 削除されるフリートのプロビジョニング状態。

FleetUpdateStrategiesCreateOrUpdateResponse

createOrUpdate 操作の応答データが含まれます。

FleetUpdateStrategiesGetResponse

get 操作の応答データが含まれます。

FleetUpdateStrategiesListByFleetNextResponse

listByFleetNext 操作の応答データを格納します。

FleetUpdateStrategiesListByFleetResponse

listByFleet 操作の応答データが含まれます。

FleetUpdateStrategyProvisioningState

FleetUpdateStrategyProvisioningState の値を定義します。
KnownFleetUpdateStrategyProvisioningState は FleetUpdateStrategyProvisioningState と同じ意味で使用できます。この列挙型には、サービスでサポートされている既知の値が含まれています。

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

成功: リソースが作成されました。
失敗: リソースの作成に失敗しました。
キャンセル済み: リソースの作成が取り消されました。

FleetsCreateOrUpdateResponse

createOrUpdate 操作の応答データが含まれます。

FleetsGetResponse

get 操作の応答データが含まれます。

FleetsListByResourceGroupNextResponse

listByResourceGroupNext 操作の応答データが含まれます。

FleetsListByResourceGroupResponse

listByResourceGroup 操作の応答データが含まれます。

FleetsListBySubscriptionNextResponse

listBySubscriptionNext 操作の応答データを格納します。

FleetsListBySubscriptionResponse

listBySubscription 操作の応答データが含まれます。

FleetsListCredentialsResponse

listCredentials 操作の応答データが含まれます。

FleetsUpdateResponse

更新操作の応答データが含まれます。

ManagedClusterUpgradeType

ManagedClusterUpgradeType の値を定義します。
KnownManagedClusterUpgradeType は ManagedClusterUpgradeType と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

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

Full: ターゲット ManagedClusters のコントロール プレーンとすべてのエージェント プールを完全にアップグレードします。 ManagedClusterUpgradeSpec.KubernetesVersion プロパティを設定する必要があります。
NodeImageOnly: NodeImageOnly は、ターゲット ManagedClusters のノード イメージのみをアップグレードします。 ManagedClusterUpgradeSpec.KubernetesVersion プロパティを設定しないようにする必要があります。
ControlPlaneOnly: ControlPlaneOnly のアップグレードは、ManagedClusters の KubernetesVersion のみを対象としており、AgentPool には適用されません。 ManagedClusterUpgradeSpec.KubernetesVersion プロパティを設定する必要があります。

ManagedServiceIdentityType

ManagedServiceIdentityType の値を定義します。
KnownManagedServiceIdentityType は ManagedServiceIdentityType と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

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

なし
SystemAssigned
UserAssigned
SystemAssigned、UserAssigned

NodeImageSelectionType

NodeImageSelectionType の値を定義します。
KnownNodeImageSelectionType は NodeImageSelectionType と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

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

最新: ノードをアップグレードするときは、最新のイメージ バージョンを使用します。 クラスターでは、異なるイメージ バージョン (例: 'AKSUbuntu-1804gen2containerd-2021.10.12' と 'AKSUbuntu-1804gen2containerd-2021.10.19' など) を使用できます。たとえば、利用可能な最新バージョンは異なるリージョンで異なるためです。
一貫性: ノードをアップグレードするイメージ バージョンは、次の説明に従って選択されます。更新実行の影響を受けるマネージド クラスター内の各ノード プールについて、システムは、同じイメージ の種類の他のすべてのノード プール (他のすべてのクラスター内) で使用できるように、最新のイメージ バージョンを選択します。 その結果、同じイメージ タイプのすべてのノード プールが同じイメージ バージョンにアップグレードされます。 たとえば、イメージの種類 'AKSUbuntu-1804gen2containerd' の最新のイメージ バージョンが、リージョン X のクラスター A のノード プールの 'AKSUbuntu-1804gen2containerd-2021.10.12' である場合、 と は、リージョン Y のクラスター B のノード プールの 'AKSUbuntu-1804gen2containerd-2021.10.17' です。システムは両方のノード プールをイメージ バージョン 'AKSUbuntu-1804gen2containerd-2021.10.12' にアップグレードします。

OperationsListNextResponse

listNext 操作の応答データを格納します。

OperationsListResponse

リスト操作の応答データが含まれます。

Origin

Origin の値を定義します。
KnownOrigin は Origin と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

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

user
システム
user,system

TargetType

TargetType の値を定義します。
KnownTargetType は TargetType と同じ意味で使用できます。この列挙型には、サービスでサポートされている既知の値が含まれています。

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

メンバー: メンバーの更新をスキップします。
グループ: グループの更新をスキップします。
ステージ: ステージ待機後を含むステージ全体の更新をスキップします。
AfterStageWait: 特定のステージの after ステージ待機の更新をスキップします。

UpdateRunProvisioningState

UpdateRunProvisioningState の値を定義します。
KnownUpdateRunProvisioningState は UpdateRunProvisioningState と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

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

成功: リソースが作成されました。
失敗: リソースの作成に失敗しました。
キャンセル済み: リソースの作成が取り消されました。

UpdateRunsCreateOrUpdateResponse

createOrUpdate 操作の応答データを格納します。

UpdateRunsGetResponse

get 操作の応答データが含まれます。

UpdateRunsListByFleetNextResponse

listByFleetNext 操作の応答データを格納します。

UpdateRunsListByFleetResponse

listByFleet 操作の応答データを格納します。

UpdateRunsSkipResponse

スキップ操作の応答データが含まれます。

UpdateRunsStartResponse

開始操作の応答データが含まれます。

UpdateRunsStopResponse

停止操作の応答データが含まれます。

UpdateState

UpdateState の値を定義します。
KnownUpdateState は UpdateState と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

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

NotStarted: 開始されていない UpdateRun/UpdateStage/UpdateGroup/MemberUpdate の状態。
実行中: 実行中の UpdateRun/UpdateStage/UpdateGroup/MemberUpdate の状態。
停止中: 停止している UpdateRun/UpdateStage/UpdateGroup/MemberUpdate の状態。
停止済み: 停止した UpdateRun/UpdateStage/UpdateGroup/MemberUpdate の状態。
スキップ済み: スキップされた UpdateRun/UpdateStage/UpdateGroup/MemberUpdate の状態。
失敗: 失敗した UpdateRun/UpdateStage/UpdateGroup/MemberUpdate の状態。
完了: 完了した UpdateRun/UpdateStage/UpdateGroup/MemberUpdate の状態。

列挙型

KnownActionType

サービスが受け入れる ActionType の既知の値。

KnownCreatedByType

サービスが受け入れる CreatedByType の既知の値。

KnownFleetMemberProvisioningState

サービスが受け入れる FleetMemberProvisioningState の既知の値。

KnownFleetProvisioningState

サービスが受け入れる FleetProvisioningState の既知の値。

KnownFleetUpdateStrategyProvisioningState

サービスが受け入れる FleetUpdateStrategyProvisioningState の既知の値。

KnownManagedClusterUpgradeType

サービスが受け入れる ManagedClusterUpgradeType の既知の値。

KnownManagedServiceIdentityType

サービスが受け入れる ManagedServiceIdentityType の既知の値。

KnownNodeImageSelectionType

サービスが受け入れる NodeImageSelectionType の既知の値。

KnownOrigin

サービスが受け入れる Origin の既知の値。

KnownTargetType

サービスが受け入れる TargetType の既知の値。

KnownUpdateRunProvisioningState

サービスが受け入れる UpdateRunProvisioningState の既知の値。

KnownUpdateState

サービスが受け入れる UpdateState の既知の値。

機能

getContinuationToken(unknown)

反復子によってbyPage最後.valueに生成された を指定すると、後でそのポイントからページングを開始するために使用できる継続トークンが返されます。

関数の詳細

getContinuationToken(unknown)

反復子によってbyPage最後.valueに生成された を指定すると、後でそのポイントからページングを開始するために使用できる継続トークンが返されます。

function getContinuationToken(page: unknown): string | undefined

パラメーター

page

unknown

反復子から IteratorResult にアクセス value する byPage オブジェクト。

戻り値

string | undefined

今後の呼び出し中に byPage() に渡すことができる継続トークン。