Delen via


@azure/arm-containerservicefleet package

Klassen

ContainerServiceFleetClient

Interfaces

APIServerAccessProfile

Toegangsprofiel voor de Fleet Hub API-server.

AgentProfile

Agentprofiel voor de Fleet-hub.

AutoUpgradeNodeImageSelection

De upgrade van de knooppuntinstallatiekopie die moet worden toegepast op de doelclusters in automatische upgrade.

AutoUpgradeProfile

De Resource AutoUpgradeProfile.

AutoUpgradeProfileOperationsGenerateUpdateRunOptionalParams

Optionele parameters.

AutoUpgradeProfileOperationsOperations

Interface die een AutoUpgradeProfileOperations-bewerking vertegenwoordigt.

AutoUpgradeProfileProperties

De eigenschappen van het AutoUpgradeProfile.

AutoUpgradeProfileStatus

AutoUpgradeProfileStatus is de status van een profiel voor automatische upgrade.

AutoUpgradeProfilesCreateOrUpdateOptionalParams

Optionele parameters.

AutoUpgradeProfilesDeleteOptionalParams

Optionele parameters.

AutoUpgradeProfilesGetOptionalParams

Optionele parameters.

AutoUpgradeProfilesListByFleetOptionalParams

Optionele parameters.

AutoUpgradeProfilesOperations

Interface die een AutoUpgradeProfiles-bewerking vertegenwoordigt.

ContainerServiceFleetClientOptionalParams

Optionele parameters voor de client.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen.

Fleet

De Vlootresource.

FleetCredentialResult

Eén referentieresultaatitem.

FleetCredentialResults

Het antwoord op de referentieresultaten.

FleetHubProfile

Het FleetHubProfile configureert de vloothub.

FleetMember

Lid van de Vloot. Het bevat een verwijzing naar een bestaand Kubernetes-cluster in Azure.

FleetMemberProperties

Lid van de Vloot. Het bevat een verwijzing naar een bestaand Kubernetes-cluster in Azure.

FleetMemberStatus

Statusinformatie voor het vlootlid

FleetMemberUpdate

Het type dat wordt gebruikt voor updatebewerkingen van de FleetMember.

FleetMemberUpdateProperties

De bijwerkbare eigenschappen van de FleetMember.

FleetMembersCreateOptionalParams

Optionele parameters.

FleetMembersDeleteOptionalParams

Optionele parameters.

FleetMembersGetOptionalParams

Optionele parameters.

FleetMembersListByFleetOptionalParams

Optionele parameters.

FleetMembersOperations

Interface die een FleetMembers-operatie vertegenwoordigt.

FleetMembersUpdateAsyncOptionalParams

Optionele parameters.

FleetPatch

Eigenschappen van een vloot die kan worden gepatcht.

FleetProperties

Vloot eigenschappen.

FleetStatus

Statusinformatie voor de vloot.

FleetUpdateStrategiesCreateOrUpdateOptionalParams

Optionele parameters.

FleetUpdateStrategiesDeleteOptionalParams

Optionele parameters.

FleetUpdateStrategiesGetOptionalParams

Optionele parameters.

FleetUpdateStrategiesListByFleetOptionalParams

Optionele parameters.

FleetUpdateStrategiesOperations

Interface die een FleetUpdateStrategies-bewerkingen vertegenwoordigt.

FleetUpdateStrategy

Definieert een proces met meerdere fasen voor het uitvoeren van updatebewerkingen voor leden van een Fleet.

FleetUpdateStrategyProperties

De eigenschappen van de UpdateStrategy.

FleetsCreateOptionalParams

Optionele parameters.

FleetsDeleteOptionalParams

Optionele parameters.

FleetsGetOptionalParams

Optionele parameters.

FleetsListByResourceGroupOptionalParams

Optionele parameters.

FleetsListBySubscriptionOptionalParams

Optionele parameters.

FleetsListCredentialsOptionalParams

Optionele parameters.

FleetsOperations

Interface die een Fleets-bewerking vertegenwoordigt.

FleetsUpdateAsyncOptionalParams

Optionele parameters.

GenerateResponse

GenerateResponse is het antwoord van een genererende aanvraag.

ManagedClusterUpdate

De update die moet worden toegepast op de ManagedClusters.

ManagedClusterUpgradeSpec

De upgrade die moet worden toegepast op een ManagedCluster.

ManagedServiceIdentity

Beheerde service-identiteit (door het systeem toegewezen en/of door de gebruiker toegewezen identiteiten)

MemberUpdateStatus

De status van een updatebewerking voor leden.

NodeImageSelection

De upgrade van de knooppuntinstallatiekopieën die moeten worden toegepast op de doelknooppunten in updateuitvoering.

NodeImageSelectionStatus

De upgradespecificaties van de knooppuntinstallatiekopieën voor de updateuitvoering.

NodeImageVersion

De versie van de upgrade van de knooppuntinstallatiekopieën.

Operation

Details van een REST API-bewerking, geretourneerd door de Resource Provider Operations-API

OperationDisplay

Gelokaliseerde weergavegegevens voor en bewerkingen.

OperationsListOptionalParams

Optionele parameters.

OperationsOperations

Interface voor bewerkingen.

PageSettings

Opties voor de methode byPage

PagedAsyncIterableIterator

Een interface waarmee asynchrone iteratie zowel kan worden voltooid als per pagina.

ProxyResource

De definitie van het resourcemodel voor een Azure Resource Manager-proxyresource. Het heeft geen tags en een locatie

Resource

Algemene velden die worden geretourneerd in het antwoord voor alle Azure Resource Manager-resources

RestorePollerOptions
SkipProperties

De eigenschappen van een skip-bewerking met meerdere aanvragen voor overslaan.

SkipTarget

De definitie van één aanvraag voor overslaan.

SystemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

TrackedResource

De definitie van het resourcemodel voor een azure Resource Manager heeft een resource op het hoogste niveau bijgehouden met tags en een locatie

UpdateGroup

Een groep die moet worden bijgewerkt.

UpdateGroupStatus

De status van een UpdateGroup.

UpdateRun

Een proces met meerdere fasen voor het uitvoeren van updatebewerkingen voor leden van een Vloot.

UpdateRunProperties

De eigenschappen van de UpdateRun.

UpdateRunStatus

De status van een UpdateRun.

UpdateRunStrategy

Definieert de updatevolgorde van de clusters via fasen en groepen.

Fasen binnen een uitvoering worden opeenvolgend uitgevoerd. Groepen binnen een fase worden parallel uitgevoerd. Lidclusters binnen een groep worden opeenvolgend bijgewerkt.

Een geldige strategie bevat geen dubbele groepen binnen of tussen fasen.

UpdateRunsCreateOrUpdateOptionalParams

Optionele parameters.

UpdateRunsDeleteOptionalParams

Optionele parameters.

UpdateRunsGetOptionalParams

Optionele parameters.

UpdateRunsListByFleetOptionalParams

Optionele parameters.

UpdateRunsOperations

Interface die een UpdateRuns-bewerking vertegenwoordigt.

UpdateRunsSkipOptionalParams

Optionele parameters.

UpdateRunsStartOptionalParams

Optionele parameters.

UpdateRunsStopOptionalParams

Optionele parameters.

UpdateStage

Definieert een fase die de groepen bevat die moeten worden bijgewerkt en de stappen die moeten worden uitgevoerd (bijvoorbeeld wachten op een bepaalde periode) voordat de volgende fase wordt gestart.

UpdateStageStatus

De status van een UpdateStage.

UpdateStatus

De status voor een bewerking of groep bewerkingen.

UserAssignedIdentity

Door de gebruiker toegewezen identiteitseigenschappen

WaitStatus

De status van de wachttijd.

Type-aliassen

ActionType

Uitbreidbare opsomming. Geeft het actietype aan. 'Intern' verwijst naar acties die alleen voor interne API's zijn.
KnownActionType kan door elkaar worden gebruikt met ActionType, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

Intern: Acties zijn voor interne API's.

AutoUpgradeLastTriggerStatus

AutoUpgradeLastTriggerStatus is de status van de laatste AutoUpgrade-trigger (poging om automatisch UpdateRun te maken en te starten wanneer er nieuwe uitgebrachte versies zijn) van een profiel voor automatische upgrade.
KnownAutoUpgradeLastTriggerStatus kan door elkaar worden gebruikt met AutoUpgradeLastTriggerStatus, deze enum bevat de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

Geslaagd: de laatste AutoUpgrade-trigger is geslaagd.
Mislukt: de laatste AutoUpgrade-trigger is mislukt.

AutoUpgradeNodeImageSelectionType

Het upgradetype van de knooppuntinstallatiekopie.
KnownAutoUpgradeNodeImageSelectionType kan door elkaar worden gebruikt met AutoUpgradeNodeImageSelectionType, deze enum bevat de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

Meest recente: gebruik de meest recente versie van de installatiekopieën bij het upgraden van knooppunten. Clusters kunnen verschillende versies van installatiekopieën gebruiken (bijvoorbeeld 'AKSShell-1804gen2containerd-2021.10.12' en 'AKSShell-1804gen2containerd-2021.10.19') omdat de meest recente beschikbare versie bijvoorbeeld verschilt in verschillende regio's.
Consistent: de installatiekopieversies waarnaar knooppunten moeten worden bijgewerkt, zoals hieronder wordt beschreven: voor elke knooppuntgroep in beheerde clusters die worden beïnvloed door de updateuitvoering, selecteert het systeem de meest recente versie van de installatiekopie, zodat deze beschikbaar is in alle andere knooppuntgroepen (in alle andere clusters) van hetzelfde installatiekopietype. Als gevolg hiervan worden alle knooppuntgroepen van hetzelfde type installatiekopie bijgewerkt naar dezelfde versie van de installatiekopie. Als de meest recente versie van de installatiekopie voor het afbeeldingstype 'AKSShell-1804gen2containerd' bijvoorbeeld 'AKSShell-1804gen2containerd-2021.10.12' is voor een knooppuntgroep in cluster A in regio X, en is 'AKSOpgegeven-1804gen2containerd-2021.10.17' voor een knooppuntgroep in cluster B in regio Y, het systeem zal beide knooppuntgroepen upgraden naar de installatiekopieversie 'AKSShell-1804gen2containerd-2021.10.12'.

AutoUpgradeProfileProvisioningState

De inrichtingsstatus van de Resource AutoUpgradeProfile.
KnownAutoUpgradeProfileProvisioningState kan door elkaar worden gebruikt met AutoUpgradeProvisioningState, bevat deze opsomming de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

geslaagde: resource is gemaakt.
mislukt: het maken van resources is mislukt.
Geannuleerd: het maken van resources is geannuleerd.

ContinuablePage

Een interface die een pagina met resultaten beschrijft.

CreatedByType

Het type entiteit dat de resource heeft gemaakt.
<xref:KnowncreatedByType> kan door elkaar worden gebruikt met createdByType, bevat deze enum de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

Gebruiker: De entiteit is gemaakt door een gebruiker.
Toepassing: De entiteit is gemaakt door een toepassing.
ManagedIdentity: de entiteit is gemaakt door een beheerde identiteit.
Sleutel: De entiteit is gemaakt door een sleutel.

FleetMemberProvisioningState

De inrichtingsstatus van de laatst geaccepteerde bewerking.
KnownFleetMemberProvisioningState kan door elkaar worden gebruikt met FleetMemberProvisioningState, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

geslaagde: resource is gemaakt.
mislukt: het maken van resources is mislukt.
Geannuleerd: het maken van resources is geannuleerd.
Lid worden van: de inrichtingsstatus van een lid die lid wordt van een vloot.
Verlaten: De inrichtingsstatus van een lid die een vloot verlaat.
bijwerken: de inrichtingsstatus van een lid die wordt bijgewerkt.

FleetProvisioningState

De inrichtingsstatus van de laatst geaccepteerde bewerking.
KnownFleetProvisioningState kan door elkaar worden gebruikt met FleetProvisioningState, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

geslaagde: resource is gemaakt.
mislukt: het maken van resources is mislukt.
Geannuleerd: het maken van resources is geannuleerd.
Maken van: de inrichtingsstatus van een vloot die wordt gemaakt.
bijwerken: de inrichtingsstatus van een vloot die wordt bijgewerkt.
verwijderen: de inrichtingsstatus van een vloot die wordt verwijderd.

FleetUpdateStrategyProvisioningState

De inrichtingsstatus van de UpdateStrategy-resource.
KnownFleetUpdateStrategyProvisioningState kan door elkaar worden gebruikt met FleetUpdateStrategyProvisioningState, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

geslaagde: resource is gemaakt.
mislukt: het maken van resources is mislukt.
Geannuleerd: het maken van resources is geannuleerd.

ManagedClusterUpgradeType

Het type upgrade dat moet worden uitgevoerd bij het instellen van ManagedClusters.
KnownManagedClusterUpgradeType kan door elkaar worden gebruikt met ManagedClusterUpgradeType, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

volledige: het besturingsvlak en alle agentpools van de doelclusters worden bijgewerkt. Hiervoor moet de eigenschap ManagedClusterUpgradeSpec.KubernetesVersion worden ingesteld.
NodeImageOnly: NodeImageOnly werkt alleen de knooppuntinstallatiekopieën van de beheerde doelclusters bij. Vereist dat de eigenschap ManagedClusterUpgradeSpec.KubernetesVersion NIET is ingesteld.
ControlPlaneOnly-: ControlPlaneOnly-upgrades zijn alleen gericht op de KubernetesVersion van de ManagedClusters en worden niet toegepast op agentpool. Hiervoor moet de eigenschap ManagedClusterUpgradeSpec.KubernetesVersion worden ingesteld.

ManagedServiceIdentityType

Type beheerde service-identiteit (waarbij zowel SystemAssigned- als UserAssigned-typen zijn toegestaan).
KnownManagedServiceIdentityType kan door elkaar worden gebruikt met ManagedServiceIdentityType, bevat dit enum de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

Geen: Geen beheerde identiteit.
SystemAssigned: Door het systeem toegewezen beheerde identiteit.
UserAssigned: door de gebruiker toegewezen beheerde identiteit.
SystemAssigned, UserAssigned: Systeem en gebruiker toegewezen beheerde identiteit.

NodeImageSelectionType

Het upgradetype van de knooppuntinstallatiekopie.
KnownNodeImageSelectionType kan door elkaar worden gebruikt met NodeImageSelectionType, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

Meest recente: gebruik de meest recente versie van de installatiekopieën bij het upgraden van knooppunten. Clusters kunnen verschillende versies van installatiekopieën gebruiken (bijvoorbeeld 'AKSShell-1804gen2containerd-2021.10.12' en 'AKSShell-1804gen2containerd-2021.10.19') omdat de meest recente beschikbare versie bijvoorbeeld verschilt in verschillende regio's.
Consistent: de installatiekopieversies waarnaar knooppunten moeten worden bijgewerkt, zoals hieronder wordt beschreven: voor elke knooppuntgroep in beheerde clusters die worden beïnvloed door de updateuitvoering, selecteert het systeem de meest recente versie van de installatiekopie, zodat deze beschikbaar is in alle andere knooppuntgroepen (in alle andere clusters) van hetzelfde installatiekopietype. Als gevolg hiervan worden alle knooppuntgroepen van hetzelfde type installatiekopie bijgewerkt naar dezelfde versie van de installatiekopie. Als de meest recente versie van de installatiekopie voor het afbeeldingstype 'AKSShell-1804gen2containerd' bijvoorbeeld 'AKSShell-1804gen2containerd-2021.10.12' is voor een knooppuntgroep in cluster A in regio X, en is 'AKSOpgegeven-1804gen2containerd-2021.10.17' voor een knooppuntgroep in cluster B in regio Y, het systeem zal beide knooppuntgroepen upgraden naar de installatiekopieversie 'AKSShell-1804gen2containerd-2021.10.12'.
Aangepast: Upgrade de knooppunten naar de aangepaste afbeeldingsversies. Wanneer de update is ingesteld, worden knooppuntinstallatiekopieversies gebruikt die zijn opgegeven in customNodeImageVersions om de knooppunten te upgraden. Indien ingesteld, mag customNodeImageVersions niet leeg zijn.

Origin

De beoogde uitvoerder van de bewerking; zoals in RBAC (Resource Based Access Control) en auditlogboeken UX. De standaardwaarde is 'gebruiker,systeem'
KnownOrigin- kan door elkaar worden gebruikt met Origin, bevat deze opsomming de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

gebruiker: Geeft aan dat de bewerking wordt gestart door een gebruiker.
systeem: Geeft aan dat de bewerking wordt gestart door een systeem.
gebruiker,systeem: Geeft aan dat de bewerking wordt gestart door een gebruiker of systeem.

TargetType

Het doeltype van een skip-aanvraag.
KnownTargetType kan door elkaar worden gebruikt met TargetType, bevat deze opsomming de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

lid: sla de update van een lid over.
groep: sla de update van een groep over.
fase: sla de update van een hele fase over, inclusief de wachttijd na de fase.
AfterStageWait: Sla de update van de nafasewacht van een bepaalde fase over.

UpdateRunProvisioningState

De inrichtingsstatus van de UpdateRun-resource.
KnownUpdateRunProvisioningState kan door elkaar worden gebruikt met UpdateRunProvisioningState, bevat dit enum de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

geslaagde: resource is gemaakt.
mislukt: het maken van resources is mislukt.
Geannuleerd: het maken van resources is geannuleerd.

UpdateState

De status van de UpdateRun, UpdateStage, UpdateGroup of MemberUpdate.
KnownUpdateState- kan door elkaar worden gebruikt met UpdateState, bevat deze opsomming de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

NotStarted: de status van een UpdateRun/UpdateStage/UpdateGroup/MemberUpdate die niet is gestart.
Wordt uitgevoerd: de status van een UpdateRun/UpdateStage/UpdateGroup/MemberUpdate die wordt uitgevoerd.
stoppen: de status van een UpdateRun/UpdateStage/UpdateGroup/MemberUpdate die wordt gestopt.
gestopt: de status van een UpdateRun/UpdateStage/UpdateGroup/MemberUpdate die is gestopt.
overgeslagen: de status van een UpdateRun/UpdateStage/UpdateGroup/MemberUpdate die is overgeslagen.
Mislukt: de status van een UpdateRun/UpdateStage/UpdateGroup/MemberUpdate die is mislukt.
Voltooid: de status van een UpdateRun/UpdateStage/UpdateGroup/MemberUpdate die is voltooid.

UpgradeChannel

Configuratie van hoe automatische upgrade wordt uitgevoerd.
KnownUpgradeChannel kan door elkaar worden gebruikt met UpgradeChannel, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

Stabiele: hiermee wordt de kubernetes-versie van de clusters bijgewerkt naar de meest recente ondersteunde patchrelease op secundaire versie N-1, waarbij N de meest recente ondersteunde secundaire versie is. Als een cluster bijvoorbeeld versie 1.17.7 en versie 1.17.9, 1.18.4, 1.18.6 en 1.19.1 beschikbaar is, zijn de clusterupgrades naar 1.18.6 beschikbaar.
Rapid: hiermee wordt de kubernetes-versie van de clusters bijgewerkt naar de meest recente ondersteunde patchrelease op de meest recente ondersteunde secundaire versie.
NodeImage: upgrade van de versie van de clusterinstallatiekopie van het knooppunt.

Enums

KnownActionType

Uitbreidbare opsomming. Geeft het actietype aan. 'Intern' verwijst naar acties die alleen voor interne API's zijn.

KnownAutoUpgradeLastTriggerStatus

AutoUpgradeLastTriggerStatus is de status van de laatste AutoUpgrade-trigger (poging om automatisch UpdateRun te maken en te starten wanneer er nieuwe uitgebrachte versies zijn) van een profiel voor automatische upgrade.

KnownAutoUpgradeNodeImageSelectionType

Het upgradetype van de knooppuntinstallatiekopie.

KnownAutoUpgradeProfileProvisioningState

De inrichtingsstatus van de Resource AutoUpgradeProfile.

KnownCreatedByType

Het type entiteit dat de resource heeft gemaakt.

KnownFleetMemberProvisioningState

De inrichtingsstatus van de laatst geaccepteerde bewerking.

KnownFleetProvisioningState

De inrichtingsstatus van de laatst geaccepteerde bewerking.

KnownFleetUpdateStrategyProvisioningState

De inrichtingsstatus van de UpdateStrategy-resource.

KnownManagedClusterUpgradeType

Het type upgrade dat moet worden uitgevoerd bij het instellen van ManagedClusters.

KnownManagedServiceIdentityType

Type beheerde service-identiteit (waarbij zowel SystemAssigned- als UserAssigned-typen zijn toegestaan).

KnownNodeImageSelectionType

Het upgradetype van de knooppuntinstallatiekopie.

KnownOrigin

De beoogde uitvoerder van de bewerking; zoals in RBAC (Resource Based Access Control) en auditlogboeken UX. De standaardwaarde is 'gebruiker,systeem'

KnownTargetType

Het doeltype van een skip-aanvraag.

KnownUpdateRunProvisioningState

De inrichtingsstatus van de UpdateRun-resource.

KnownUpdateState

De status van de UpdateRun, UpdateStage, UpdateGroup of MemberUpdate.

KnownUpgradeChannel

Configuratie van hoe automatische upgrade wordt uitgevoerd.

KnownVersions

Azure Kubernetes Fleet Manager API-versies.

Functies

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

Hiermee maakt u een poller op basis van de geserialiseerde status van een andere poller. Dit kan handig zijn als u pollers wilt maken op een andere host of een poller moet worden gemaakt nadat het oorspronkelijke poller niet binnen het bereik valt.

Functiedetails

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

Hiermee maakt u een poller op basis van de geserialiseerde status van een andere poller. Dit kan handig zijn als u pollers wilt maken op een andere host of een poller moet worden gemaakt nadat het oorspronkelijke poller niet binnen het bereik valt.

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

Parameters

serializedState

string

sourceOperation

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

Retouren

PollerLike<OperationState<TResult>, TResult>