Dela via


@azure/arm-containerservicefleet package

Klasser

ContainerServiceFleetClient

Gränssnitt

APIServerAccessProfile

Åtkomstprofil för Fleet Hub API-servern.

AgentProfile

Agentprofil för Fleet Hub.

AutoUpgradeNodeImageSelection

Den nodavbildningsuppgradering som ska tillämpas på målkluster i automatisk uppgradering.

AutoUpgradeProfile

AutoUpgradeProfile-resursen.

AutoUpgradeProfileOperationsGenerateUpdateRunOptionalParams

Valfria parametrar.

AutoUpgradeProfileOperationsOperations

Gränssnitt som representerar en AutoUpgradeProfileOperations-åtgärd.

AutoUpgradeProfileProperties

Egenskaperna för AutoUpgradeProfile.

AutoUpgradeProfileStatus

AutoUpgradeProfileStatus är status för en profil för automatisk uppgradering.

AutoUpgradeProfilesCreateOrUpdateOptionalParams

Valfria parametrar.

AutoUpgradeProfilesDeleteOptionalParams

Valfria parametrar.

AutoUpgradeProfilesGetOptionalParams

Valfria parametrar.

AutoUpgradeProfilesListByFleetOptionalParams

Valfria parametrar.

AutoUpgradeProfilesOperations

Gränssnitt som representerar en AutoUpgradeProfiles-åtgärd.

ContainerServiceFleetClientOptionalParams

Valfria parametrar för klienten.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder.

Fleet

Fleet-resursen.

FleetCredentialResult

Ett resultatobjekt för autentiseringsuppgifter.

FleetCredentialResults

Svar på autentiseringsuppgifter.

FleetHubProfile

FleetHubProfile konfigurerar navet för flottan.

FleetMember

Medlem i flottan. Den innehåller en referens till ett befintligt Kubernetes-kluster i Azure.

FleetMemberProperties

Medlem i flottan. Den innehåller en referens till ett befintligt Kubernetes-kluster i Azure.

FleetMemberStatus

Statusinformation för flottans medlem

FleetMemberUpdate

Den typ som används för uppdateringsåtgärder för FleetMember.

FleetMemberUpdateProperties

De uppdaterbara egenskaperna för FleetMember.

FleetMembersCreateOptionalParams

Valfria parametrar.

FleetMembersDeleteOptionalParams

Valfria parametrar.

FleetMembersGetOptionalParams

Valfria parametrar.

FleetMembersListByFleetOptionalParams

Valfria parametrar.

FleetMembersOperations

Gränssnitt som representerar en FleetMembers-verksamhet.

FleetMembersUpdateAsyncOptionalParams

Valfria parametrar.

FleetPatch

Egenskaper för en flotta som kan korrigeras.

FleetProperties

Flottans egenskaper.

FleetStatus

Statusinformation för flottan.

FleetUpdateStrategiesCreateOrUpdateOptionalParams

Valfria parametrar.

FleetUpdateStrategiesDeleteOptionalParams

Valfria parametrar.

FleetUpdateStrategiesGetOptionalParams

Valfria parametrar.

FleetUpdateStrategiesListByFleetOptionalParams

Valfria parametrar.

FleetUpdateStrategiesOperations

Gränssnitt som representerar en FleetUpdateStrategies-åtgärd.

FleetUpdateStrategy

Definierar en process i flera steg för att utföra uppdateringsåtgärder för medlemmar i en flotta.

FleetUpdateStrategyProperties

Egenskaperna för UpdateStrategy.

FleetsCreateOptionalParams

Valfria parametrar.

FleetsDeleteOptionalParams

Valfria parametrar.

FleetsGetOptionalParams

Valfria parametrar.

FleetsListByResourceGroupOptionalParams

Valfria parametrar.

FleetsListBySubscriptionOptionalParams

Valfria parametrar.

FleetsListCredentialsOptionalParams

Valfria parametrar.

FleetsOperations

Gränssnitt som representerar en Fleets-verksamhet.

FleetsUpdateAsyncOptionalParams

Valfria parametrar.

GenerateResponse

GenerateResponse är svaret på en generate-begäran.

ManagedClusterUpdate

Uppdateringen som ska tillämpas på ManagedClusters.

ManagedClusterUpgradeSpec

Uppgraderingen som ska tillämpas på en ManagedCluster.

ManagedServiceIdentity

Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)

MemberUpdateStatus

Status för en medlemsuppdateringsåtgärd.

NodeImageSelection

Den nodbilduppgradering som ska tillämpas på målnoderna i uppdateringskörningen.

NodeImageSelectionStatus

Specifikationerna för nodbilduppgradering för uppdateringskörningen.

NodeImageVersion

Avbildningsversionen för noduppgradering.

Operation

Information om en REST API-åtgärd som returneras från API:et för resursprovideråtgärder

OperationDisplay

Lokaliserad visningsinformation för och åtgärd.

OperationsListOptionalParams

Valfria parametrar.

OperationsOperations

Gränssnitt som representerar åtgärder.

PageSettings

Alternativ för byPage-metoden

PagedAsyncIterableIterator

Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida.

ProxyResource

Resursmodelldefinitionen för en Azure Resource Manager-proxyresurs. Det kommer inte att ha taggar och en plats

Resource

Vanliga fält som returneras i svaret för alla Azure Resource Manager-resurser

RestorePollerOptions
SkipProperties

Egenskaperna för en hoppa över-åtgärd som innehåller flera hoppbegäranden.

SkipTarget

Definitionen av en enda hoppbegäran.

SystemData

Metadata som rör skapande och senaste ändring av resursen.

TrackedResource

Resursmodelldefinitionen för en Azure Resource Manager-spårad resurs på den översta nivån som har "taggar" och en "plats"

UpdateGroup

En grupp som ska uppdateras.

UpdateGroupStatus

Status för en UpdateGroup.

UpdateRun

En process i flera steg för att utföra uppdateringsåtgärder för medlemmar i en flotta.

UpdateRunProperties

Egenskaperna för UpdateRun.

UpdateRunStatus

Status för en UpdateRun.

UpdateRunStrategy

Definierar uppdateringssekvensen för klustren via faser och grupper.

Faser i en körning körs sekventiellt en efter en. Grupper i en fas körs parallellt. Medlemskluster i en grupp uppdateras sekventiellt en efter en.

En giltig strategi innehåller inga duplicerade grupper inom eller mellan faser.

UpdateRunsCreateOrUpdateOptionalParams

Valfria parametrar.

UpdateRunsDeleteOptionalParams

Valfria parametrar.

UpdateRunsGetOptionalParams

Valfria parametrar.

UpdateRunsListByFleetOptionalParams

Valfria parametrar.

UpdateRunsOperations

Gränssnitt som representerar en UpdateRuns-åtgärd.

UpdateRunsSkipOptionalParams

Valfria parametrar.

UpdateRunsStartOptionalParams

Valfria parametrar.

UpdateRunsStopOptionalParams

Valfria parametrar.

UpdateStage

Definierar ett stadium som innehåller de grupper som ska uppdateras och de steg som ska utföras (t.ex. vänta en tidsperiod) innan nästa steg påbörjas.

UpdateStageStatus

Status för en UpdateStage.

UpdateStatus

Status för en åtgärd eller grupp med åtgärder.

UserAssignedIdentity

Användartilldelade identitetsegenskaper

WaitStatus

Status för väntetiden.

Typalias

ActionType

Utökningsbar uppräkning. Anger åtgärdstypen. "Intern" avser åtgärder som endast gäller interna API:er.
KnownActionType- kan användas utbytbart med ActionType innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

intern: Åtgärder gäller endast interna API:er.

AutoUpgradeLastTriggerStatus

AutoUpgradeLastTriggerStatus är status för den senaste AutoUpgrade-utlösaren (försök att automatiskt skapa och starta UpdateRun när det finns nya versioner) för en profil för automatisk uppgradering.
KnownAutoUpgradeLastTriggerStatus kan användas synonymt med AutoUpgradeLastTriggerStatus, den här uppräkningen innehåller de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Lyckades: Den senaste utlösaren för automatisk uppgradering lyckades.
Misslyckades: Den senaste utlösaren för automatisk uppgradering misslyckades.

AutoUpgradeNodeImageSelectionType

Uppgraderingstypen för nodbilden.
KnownAutoUpgradeNodeImageSelectionType kan användas utbytbart med AutoUpgradeNodeImageSelectionType innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

senaste: Använd den senaste avbildningsversionen när du uppgraderar noder. Kluster kan använda olika avbildningsversioner (t.ex. "AKSUbuntu-1804gen2containerd-2021.10.12" och "AKSUbuntu-1804gen2containerd-2021.10.19") eftersom den senaste tillgängliga versionen till exempel skiljer sig i olika regioner.
Konsekvent: De avbildningsversioner som ska uppgraderas till väljs enligt beskrivningen nedan: för varje nodpool i hanterade kluster som påverkas av uppdateringskörningen väljer systemet den senaste avbildningsversionen så att den är tillgänglig för alla andra nodpooler (i alla andra kluster) av samma avbildningstyp. Därför uppgraderas alla nodpooler av samma avbildningstyp till samma avbildningsversion. Om till exempel den senaste avbildningsversionen för bildtypen "AKSUbuntu-1804gen2containerd" är "AKSUbuntu-1804gen2containerd-2021.10.12" för en nodpool i kluster A i region X, och är "AKSUbuntu-1804gen2containerd-2021.10.17" för en nodpool i kluster B i regionen Y, uppgraderar systemet båda nodpoolerna till avbildningsversionen "AKSUbuntu-1804gen2containerd-2021.10.12".

AutoUpgradeProfileProvisioningState

Etableringstillståndet för AutoUpgradeProfile-resursen.
KnownAutoUpgradeProfileProvisioningState kan användas utbytbart med AutoUpgradeProfileProvisioningState innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

lyckades: Resursen har skapats.
Misslyckades: Det gick inte att skapa resursen.
Avbröts: Resursskapande avbröts.

ContinuablePage

Ett gränssnitt som beskriver en resultatsida.

CreatedByType

Den typ av entitet som skapade resursen.
<xref:KnowncreatedByType> kan användas omväxlande med createdByType innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Användare: Entiteten skapades av en användare.
Application: Entiteten skapades av ett program.
ManagedIdentity: Entiteten skapades av en hanterad identitet.
Nyckel: Entiteten skapades av en nyckel.

FleetMemberProvisioningState

Etableringstillståndet för den senast godkända åtgärden.
KnownFleetMemberProvisioningState kan användas omväxlande med FleetMemberProvisioningState innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

lyckades: Resursen har skapats.
Misslyckades: Det gick inte att skapa resursen.
Avbröts: Resursskapande avbröts.
Join: Etableringstillståndet för en medlem som ansluter till en flotta.
Leaving: Etableringsstaten för en medlem som lämnar en flotta.
Uppdaterar: Etableringstillståndet för en medlem som uppdateras.

FleetProvisioningState

Etableringstillståndet för den senast godkända åtgärden.
KnownFleetProvisioningState kan användas omväxlande med FleetProvisioningState innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

lyckades: Resursen har skapats.
Misslyckades: Det gick inte att skapa resursen.
Avbröts: Resursskapande avbröts.
Skapa: Etableringstillståndet för en flotta som skapas.
Uppdatera: Etableringstillståndet för en flotta som uppdateras.
Ta bort: Etableringstillståndet för en flotta som tas bort.

FleetUpdateStrategyProvisioningState

Etableringstillståndet för UpdateStrategy-resursen.
KnownFleetUpdateStrategyProvisioningState kan användas omväxlande med FleetUpdateStrategyProvisioningState innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

lyckades: Resursen har skapats.
Misslyckades: Det gick inte att skapa resursen.
Avbröts: Resursskapande avbröts.

ManagedClusterUpgradeType

Vilken typ av uppgradering som ska utföras när du riktar in dig på ManagedClusters.
KnownManagedClusterUpgradeType kan användas utbytbart med ManagedClusterUpgradeType innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Fullständig: Fullständig uppgraderar kontrollplanet och alla agentpooler i målhanteradeluster. Kräver att egenskapen ManagedClusterUpgradeSpec.KubernetesVersion anges.
NodeImageOnly: NodeImageOnly uppgraderar endast nodbilderna för målhanteradeluster. Kräver att egenskapen ManagedClusterUpgradeSpec.KubernetesVersion INTE anges.
ControlPlaneOnly: ControlPlaneOnly uppgraderar endast kubernetesVersion för ManagedClusters och kommer inte att tillämpas på AgentPool. Kräver att egenskapen ManagedClusterUpgradeSpec.KubernetesVersion anges.

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).
KnownManagedServiceIdentityType kan användas utbytbart med ManagedServiceIdentityType innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Ingen: Ingen hanterad identitet.
SystemAssigned: Systemtilldelad hanterad identitet.
UserAssigned: Användartilldelad hanterad identitet.
SystemAssigned, UserAssigned: System- och användartilldelad hanterad identitet.

NodeImageSelectionType

Uppgraderingstypen för nodbilden.
KnownNodeImageSelectionType kan användas utbytbart med NodeImageSelectionType innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

senaste: Använd den senaste avbildningsversionen när du uppgraderar noder. Kluster kan använda olika avbildningsversioner (t.ex. "AKSUbuntu-1804gen2containerd-2021.10.12" och "AKSUbuntu-1804gen2containerd-2021.10.19") eftersom den senaste tillgängliga versionen till exempel skiljer sig i olika regioner.
Konsekvent: De avbildningsversioner som ska uppgraderas till väljs enligt beskrivningen nedan: för varje nodpool i hanterade kluster som påverkas av uppdateringskörningen väljer systemet den senaste avbildningsversionen så att den är tillgänglig för alla andra nodpooler (i alla andra kluster) av samma avbildningstyp. Därför uppgraderas alla nodpooler av samma avbildningstyp till samma avbildningsversion. Om till exempel den senaste avbildningsversionen för bildtypen "AKSUbuntu-1804gen2containerd" är "AKSUbuntu-1804gen2containerd-2021.10.12" för en nodpool i kluster A i region X, och är "AKSUbuntu-1804gen2containerd-2021.10.17" för en nodpool i kluster B i regionen Y, uppgraderar systemet båda nodpoolerna till avbildningsversionen "AKSUbuntu-1804gen2containerd-2021.10.12".
Anpassad: Uppgradera noderna till de anpassade avbildningsversionerna. När den är inställd använder uppdateringskörningen nodavbildningsversioner som tillhandahålls i customNodeImageVersions för att uppgradera noderna. Om det anges får customNodeImageVersions inte vara tomt.

Origin

Den avsedda utföraren av åtgärden; som i Resursbaserad åtkomstkontroll (RBAC) och granskningsloggar UX. Standardvärdet är "user,system"
KnownOrigin- kan användas omväxlande med Origin innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

användare: Anger att åtgärden initieras av en användare.
system: Anger att åtgärden initieras av ett system.
användare, system: Anger att åtgärden initieras av en användare eller ett system.

TargetType

Måltypen för en hoppbegäran.
KnownTargetType- kan användas omväxlande med TargetType innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Medlem: Hoppa över uppdateringen av en medlem.
Grupp: Hoppa över uppdateringen av en grupp.
Stage: Hoppa över uppdateringen av en hel fas, inklusive väntetiden efter fasen.
AfterStageWait: Hoppa över uppdateringen av efterstegsväntningen för en viss fas.

UpdateRunProvisioningState

Etableringstillståndet för UpdateRun-resursen.
KnownUpdateRunProvisioningState kan användas omväxlande med UpdateRunProvisioningState innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

lyckades: Resursen har skapats.
Misslyckades: Det gick inte att skapa resursen.
Avbröts: Resursskapande avbröts.

UpdateState

Tillståndet för UpdateRun, UpdateStage, UpdateGroup eller MemberUpdate.
KnownUpdateState kan användas omväxlande med UpdateState innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

NotStarted: Tillståndet för en UpdateRun/UpdateStage/UpdateGroup/MemberUpdate som inte har startats.
Körs: Tillståndet för en UpdateRun/UpdateStage/UpdateGroup/MemberUpdate som körs.
Stoppa: Tillståndet för en UpdateRun/UpdateStage/UpdateGroup/MemberUpdate som stoppas.
har stoppats: Tillståndet för en UpdateRun/UpdateStage/UpdateGroup/MemberUpdate som har stoppats.
hoppades över: Tillståndet för en UpdateRun/UpdateStage/UpdateGroup/MemberUpdate som har hoppats över.
misslyckades: Tillståndet för en UpdateRun/UpdateStage/UpdateGroup/MemberUpdate som har misslyckats.
Slutförd: Tillståndet för en UpdateRun/UpdateStage/UpdateGroup/MemberUpdate som har slutförts.

UpgradeChannel

Konfiguration av hur automatisk uppgradering ska köras.
KnownUpgradeChannel kan användas utbytbart med UpgradeChannel innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Stabil: Uppgraderar kubernetes-versionen för kluster till den senaste korrigeringsversionen som stöds på delversion N-1, där N är den senaste delversionen som stöds. Om ett kluster till exempel kör version 1.17.7 och version 1.17.9, 1.18.4, 1.18.6 och 1.19.1 är tillgängliga uppgraderas klustret till 1.18.6.
Rapid: Uppgraderar kubernetes-versionen för kluster till den senaste uppdateringsversionen som stöds på den senaste delversionen som stöds.
NodeImage: Uppgradera nodavbildningsversionen av klustren.

Uppräkningar

KnownActionType

Utökningsbar uppräkning. Anger åtgärdstypen. "Intern" avser åtgärder som endast gäller interna API:er.

KnownAutoUpgradeLastTriggerStatus

AutoUpgradeLastTriggerStatus är status för den senaste AutoUpgrade-utlösaren (försök att automatiskt skapa och starta UpdateRun när det finns nya versioner) för en profil för automatisk uppgradering.

KnownAutoUpgradeNodeImageSelectionType

Uppgraderingstypen för nodbilden.

KnownAutoUpgradeProfileProvisioningState

Etableringstillståndet för AutoUpgradeProfile-resursen.

KnownCreatedByType

Den typ av entitet som skapade resursen.

KnownFleetMemberProvisioningState

Etableringstillståndet för den senast godkända åtgärden.

KnownFleetProvisioningState

Etableringstillståndet för den senast godkända åtgärden.

KnownFleetUpdateStrategyProvisioningState

Etableringstillståndet för UpdateStrategy-resursen.

KnownManagedClusterUpgradeType

Vilken typ av uppgradering som ska utföras när du riktar in dig på ManagedClusters.

KnownManagedServiceIdentityType

Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).

KnownNodeImageSelectionType

Uppgraderingstypen för nodbilden.

KnownOrigin

Den avsedda utföraren av åtgärden; som i Resursbaserad åtkomstkontroll (RBAC) och granskningsloggar UX. Standardvärdet är "user,system"

KnownTargetType

Måltypen för en hoppbegäran.

KnownUpdateRunProvisioningState

Etableringstillståndet för UpdateRun-resursen.

KnownUpdateState

Tillståndet för UpdateRun, UpdateStage, UpdateGroup eller MemberUpdate.

KnownUpgradeChannel

Konfiguration av hur automatisk uppgradering ska köras.

KnownVersions

API-versioner för Azure Kubernetes Fleet Manager.

Funktioner

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

Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget.

Funktionsinformation

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

Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget.

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

Parametrar

serializedState

string

sourceOperation

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

Returer

PollerLike<OperationState<TResult>, TResult>