@azure/arm-containerservicefleet package
Classes
| ContainerServiceFleetClient |
Interfaces
| APIServerAccessProfile |
Access profile for the Fleet hub API server. |
| AgentProfile |
Agent profile for the Fleet hub. |
| ContainerServiceFleetClientOptionalParams |
Optional parameters. |
| ErrorAdditionalInfo |
The resource management error additional info. |
| ErrorDetail |
The error detail. |
| ErrorResponse |
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). |
| Fleet |
The Fleet resource. |
| FleetCredentialResult |
One credential result item. |
| FleetCredentialResults |
The Credential results response. |
| FleetHubProfile |
The FleetHubProfile configures the fleet hub. |
| FleetListResult |
The response of a Fleet list operation. |
| FleetMember |
A member of the Fleet. It contains a reference to an existing Kubernetes cluster on Azure. |
| FleetMemberListResult |
The response of a FleetMember list operation. |
| FleetMemberUpdate |
The type used for update operations of the FleetMember. |
| FleetMembers |
Interface representing a FleetMembers. |
| FleetMembersCreateHeaders |
Defines headers for FleetMembers_create operation. |
| FleetMembersCreateOptionalParams |
Optional parameters. |
| FleetMembersDeleteHeaders |
Defines headers for FleetMembers_delete operation. |
| FleetMembersDeleteOptionalParams |
Optional parameters. |
| FleetMembersGetOptionalParams |
Optional parameters. |
| FleetMembersListByFleetNextOptionalParams |
Optional parameters. |
| FleetMembersListByFleetOptionalParams |
Optional parameters. |
| FleetMembersUpdateHeaders |
Defines headers for FleetMembers_update operation. |
| FleetMembersUpdateOptionalParams |
Optional parameters. |
| FleetPatch |
Properties of a Fleet that can be patched. |
| FleetUpdateStrategies |
Interface representing a FleetUpdateStrategies. |
| FleetUpdateStrategiesCreateOrUpdateHeaders |
Defines headers for FleetUpdateStrategies_createOrUpdate operation. |
| FleetUpdateStrategiesCreateOrUpdateOptionalParams |
Optional parameters. |
| FleetUpdateStrategiesDeleteHeaders |
Defines headers for FleetUpdateStrategies_delete operation. |
| FleetUpdateStrategiesDeleteOptionalParams |
Optional parameters. |
| FleetUpdateStrategiesGetOptionalParams |
Optional parameters. |
| FleetUpdateStrategiesListByFleetNextOptionalParams |
Optional parameters. |
| FleetUpdateStrategiesListByFleetOptionalParams |
Optional parameters. |
| FleetUpdateStrategy |
Defines a multi-stage process to perform update operations across members of a Fleet. |
| FleetUpdateStrategyListResult |
The response of a FleetUpdateStrategy list operation. |
| Fleets |
Interface representing a Fleets. |
| FleetsCreateOrUpdateHeaders |
Defines headers for Fleets_createOrUpdate operation. |
| FleetsCreateOrUpdateOptionalParams |
Optional parameters. |
| FleetsDeleteHeaders |
Defines headers for Fleets_delete operation. |
| FleetsDeleteOptionalParams |
Optional parameters. |
| FleetsGetOptionalParams |
Optional parameters. |
| FleetsListByResourceGroupNextOptionalParams |
Optional parameters. |
| FleetsListByResourceGroupOptionalParams |
Optional parameters. |
| FleetsListBySubscriptionNextOptionalParams |
Optional parameters. |
| FleetsListBySubscriptionOptionalParams |
Optional parameters. |
| FleetsListCredentialsOptionalParams |
Optional parameters. |
| FleetsUpdateHeaders |
Defines headers for Fleets_update operation. |
| FleetsUpdateOptionalParams |
Optional parameters. |
| ManagedClusterUpdate |
The update to be applied to the ManagedClusters. |
| ManagedClusterUpgradeSpec |
The upgrade to apply to a ManagedCluster. |
| ManagedServiceIdentity |
Managed service identity (system assigned and/or user assigned identities) |
| MemberUpdateStatus |
The status of a member update operation. |
| NodeImageSelection |
The node image upgrade to be applied to the target nodes in update run. |
| NodeImageSelectionStatus |
The node image upgrade specs for the update run. |
| NodeImageVersion |
The node upgrade image version. |
| Operation |
Details of a REST API operation, returned from the Resource Provider Operations API |
| OperationDisplay |
Localized display information for this particular operation. |
| OperationListResult |
A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. |
| Operations |
Interface representing a Operations. |
| OperationsListNextOptionalParams |
Optional parameters. |
| OperationsListOptionalParams |
Optional parameters. |
| ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
| Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
| SkipProperties |
The properties of a skip operation containing multiple skip requests. |
| SkipTarget |
The definition of a single skip request. |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
| TrackedResource |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' |
| UpdateGroup |
A group to be updated. |
| UpdateGroupStatus |
The status of a UpdateGroup. |
| UpdateRun |
A multi-stage process to perform update operations across members of a Fleet. |
| UpdateRunListResult |
The response of a UpdateRun list operation. |
| UpdateRunStatus |
The status of a UpdateRun. |
| UpdateRunStrategy |
Defines the update sequence of the clusters via stages and groups. Stages within a run are executed sequentially one after another. Groups within a stage are executed in parallel. Member clusters within a group are updated sequentially one after another. A valid strategy contains no duplicate groups within or across stages. |
| UpdateRuns |
Interface representing a UpdateRuns. |
| UpdateRunsCreateOrUpdateHeaders |
Defines headers for UpdateRuns_createOrUpdate operation. |
| UpdateRunsCreateOrUpdateOptionalParams |
Optional parameters. |
| UpdateRunsDeleteHeaders |
Defines headers for UpdateRuns_delete operation. |
| UpdateRunsDeleteOptionalParams |
Optional parameters. |
| UpdateRunsGetOptionalParams |
Optional parameters. |
| UpdateRunsListByFleetNextOptionalParams |
Optional parameters. |
| UpdateRunsListByFleetOptionalParams |
Optional parameters. |
| UpdateRunsSkipHeaders |
Defines headers for UpdateRuns_skip operation. |
| UpdateRunsSkipOptionalParams |
Optional parameters. |
| UpdateRunsStartHeaders |
Defines headers for UpdateRuns_start operation. |
| UpdateRunsStartOptionalParams |
Optional parameters. |
| UpdateRunsStopHeaders |
Defines headers for UpdateRuns_stop operation. |
| UpdateRunsStopOptionalParams |
Optional parameters. |
| UpdateStage |
Defines a stage which contains the groups to update and the steps to take (e.g., wait for a time period) before starting the next stage. |
| UpdateStageStatus |
The status of a UpdateStage. |
| UpdateStatus |
The status for an operation or group of operations. |
| UserAssignedIdentity |
User assigned identity properties |
| WaitStatus |
The status of the wait duration. |
Type Aliases
| ActionType |
Defines values for ActionType. Known values supported by the serviceInternal |
| CreatedByType |
Defines values for CreatedByType. Known values supported by the serviceUser |
| FleetMemberProvisioningState |
Defines values for FleetMemberProvisioningState. Known values supported by the serviceSucceeded: Resource has been created. |
| FleetMembersCreateResponse |
Contains response data for the create operation. |
| FleetMembersGetResponse |
Contains response data for the get operation. |
| FleetMembersListByFleetNextResponse |
Contains response data for the listByFleetNext operation. |
| FleetMembersListByFleetResponse |
Contains response data for the listByFleet operation. |
| FleetMembersUpdateResponse |
Contains response data for the update operation. |
| FleetProvisioningState |
Defines values for FleetProvisioningState. Known values supported by the serviceSucceeded: Resource has been created. |
| FleetUpdateStrategiesCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| FleetUpdateStrategiesGetResponse |
Contains response data for the get operation. |
| FleetUpdateStrategiesListByFleetNextResponse |
Contains response data for the listByFleetNext operation. |
| FleetUpdateStrategiesListByFleetResponse |
Contains response data for the listByFleet operation. |
| FleetUpdateStrategyProvisioningState |
Defines values for FleetUpdateStrategyProvisioningState. Known values supported by the serviceSucceeded: Resource has been created. |
| FleetsCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| FleetsGetResponse |
Contains response data for the get operation. |
| FleetsListByResourceGroupNextResponse |
Contains response data for the listByResourceGroupNext operation. |
| FleetsListByResourceGroupResponse |
Contains response data for the listByResourceGroup operation. |
| FleetsListBySubscriptionNextResponse |
Contains response data for the listBySubscriptionNext operation. |
| FleetsListBySubscriptionResponse |
Contains response data for the listBySubscription operation. |
| FleetsListCredentialsResponse |
Contains response data for the listCredentials operation. |
| FleetsUpdateResponse |
Contains response data for the update operation. |
| ManagedClusterUpgradeType |
Defines values for ManagedClusterUpgradeType. Known values supported by the serviceFull: Full upgrades the control plane and all agent pools of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set. |
| ManagedServiceIdentityType |
Defines values for ManagedServiceIdentityType. Known values supported by the serviceNone |
| NodeImageSelectionType |
Defines values for NodeImageSelectionType. Known values supported by the serviceLatest: Use the latest image version when upgrading nodes. Clusters may use different image versions (e.g., 'AKSUbuntu-1804gen2containerd-2021.10.12' and 'AKSUbuntu-1804gen2containerd-2021.10.19') because, for example, the latest available version is different in different regions. |
| OperationsListNextResponse |
Contains response data for the listNext operation. |
| OperationsListResponse |
Contains response data for the list operation. |
| Origin |
Defines values for Origin. Known values supported by the serviceuser |
| TargetType |
Defines values for TargetType. Known values supported by the serviceMember: Skip the update of a member. |
| UpdateRunProvisioningState |
Defines values for UpdateRunProvisioningState. Known values supported by the serviceSucceeded: Resource has been created. |
| UpdateRunsCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| UpdateRunsGetResponse |
Contains response data for the get operation. |
| UpdateRunsListByFleetNextResponse |
Contains response data for the listByFleetNext operation. |
| UpdateRunsListByFleetResponse |
Contains response data for the listByFleet operation. |
| UpdateRunsSkipResponse |
Contains response data for the skip operation. |
| UpdateRunsStartResponse |
Contains response data for the start operation. |
| UpdateRunsStopResponse |
Contains response data for the stop operation. |
| UpdateState |
Defines values for UpdateState. Known values supported by the serviceNotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started. |
Enums
Functions
| get |
Given the last |
Function Details
getContinuationToken(unknown)
Given the last .value produced by the byPage iterator,
returns a continuation token that can be used to begin paging from
that point later.
function getContinuationToken(page: unknown): string | undefined
Parameters
- page
-
unknown
An object from accessing value on the IteratorResult from a byPage iterator.
Returns
string | undefined
The continuation token that can be passed into byPage() during future calls.
Azure SDK for JavaScript