@azure/arm-containerservicefleet package

Access profile for the Fleet hub API server.

Agent profile for the Fleet hub.

Optional parameters.

The resource management error additional info.

The error detail.

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

The Fleet resource.

One credential result item.

The Credential results response.

The FleetHubProfile configures the fleet hub.

The response of a Fleet list operation.

A member of the Fleet. It contains a reference to an existing Kubernetes cluster on Azure.

The response of a FleetMember list operation.

The type used for update operations of the FleetMember.

Interface representing a FleetMembers.

Defines headers for FleetMembers_create operation.

Optional parameters.

Defines headers for FleetMembers_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Defines headers for FleetMembers_update operation.

Optional parameters.

Properties of a Fleet that can be patched.

Interface representing a FleetUpdateStrategies.

Defines headers for FleetUpdateStrategies_createOrUpdate operation.

Optional parameters.

Defines headers for FleetUpdateStrategies_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Defines a multi-stage process to perform update operations across members of a Fleet.

The response of a FleetUpdateStrategy list operation.

Interface representing a Fleets.

Defines headers for Fleets_createOrUpdate operation.

Optional parameters.

Defines headers for Fleets_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Defines headers for Fleets_update operation.

Optional parameters.

The update to be applied to the ManagedClusters.

The upgrade to apply to a ManagedCluster.

Managed service identity (system assigned and/or user assigned identities)

The status of a member update operation.

The node image upgrade to be applied to the target nodes in update run.

The node image upgrade specs for the update run.

The node upgrade image version.

Details of a REST API operation, returned from the Resource Provider Operations API

Localized display information for this particular operation.

A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

Interface representing a Operations.

Optional parameters.

Optional parameters.

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Common fields that are returned in the response for all Azure Resource Manager resources

The properties of a skip operation containing multiple skip requests.

The definition of a single skip request.

Metadata pertaining to creation and last modification of the resource.

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

A group to be updated.

The status of a UpdateGroup.

A multi-stage process to perform update operations across members of a Fleet.

The response of a UpdateRun list operation.

The status of a UpdateRun.

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.

Interface representing a UpdateRuns.

Defines headers for UpdateRuns_createOrUpdate operation.

Optional parameters.

Defines headers for UpdateRuns_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Defines headers for UpdateRuns_skip operation.

Optional parameters.

Defines headers for UpdateRuns_start operation.

Optional parameters.

Defines headers for UpdateRuns_stop operation.

Optional parameters.

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.

The status of a UpdateStage.

The status for an operation or group of operations.

User assigned identity properties

The status of the wait duration.

Defines values for ActionType.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

Defines values for FleetMemberProvisioningState.
KnownFleetMemberProvisioningState can be used interchangeably with FleetMemberProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Resource has been created.
Failed: Resource creation failed.
Canceled: Resource creation was canceled.
Joining: The provisioning state of a member joining a fleet.
Leaving: The provisioning state of a member leaving a fleet.
Updating: The provisioning state of a member being updated.

Contains response data for the create operation.

Contains response data for the get operation.

Contains response data for the listByFleetNext operation.

Contains response data for the listByFleet operation.

Contains response data for the update operation.

Defines values for FleetProvisioningState.
KnownFleetProvisioningState can be used interchangeably with FleetProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Resource has been created.
Failed: Resource creation failed.
Canceled: Resource creation was canceled.
Creating: The provisioning state of a fleet being created.
Updating: The provisioning state of a fleet being updated.
Deleting: The provisioning state of a fleet being deleted.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listByFleetNext operation.

Contains response data for the listByFleet operation.

Defines values for FleetUpdateStrategyProvisioningState.
KnownFleetUpdateStrategyProvisioningState can be used interchangeably with FleetUpdateStrategyProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Resource has been created.
Failed: Resource creation failed.
Canceled: Resource creation was canceled.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listByResourceGroupNext operation.

Contains response data for the listByResourceGroup operation.

Contains response data for the listBySubscriptionNext operation.

Contains response data for the listBySubscription operation.

Contains response data for the listCredentials operation.

Contains response data for the update operation.

Defines values for ManagedClusterUpgradeType.
KnownManagedClusterUpgradeType can be used interchangeably with ManagedClusterUpgradeType, this enum contains the known values that the service supports.

Known values supported by the service

Full: Full upgrades the control plane and all agent pools of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set.
NodeImageOnly: NodeImageOnly upgrades only the node images of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to NOT be set.
ControlPlaneOnly: ControlPlaneOnly upgrades only targets the KubernetesVersion of the ManagedClusters and will not be applied to the AgentPool. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set.

Defines values for ManagedServiceIdentityType.
KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned

Defines values for NodeImageSelectionType.
KnownNodeImageSelectionType can be used interchangeably with NodeImageSelectionType, this enum contains the known values that the service supports.

Known values supported by the service

Latest: 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.
Consistent: The image versions to upgrade nodes to are selected as described below: for each node pool in managed clusters affected by the update run, the system selects the latest image version such that it is available across all other node pools (in all other clusters) of the same image type. As a result, all node pools of the same image type will be upgraded to the same image version. For example, if the latest image version for image type 'AKSUbuntu-1804gen2containerd' is 'AKSUbuntu-1804gen2containerd-2021.10.12' for a node pool in cluster A in region X, and is 'AKSUbuntu-1804gen2containerd-2021.10.17' for a node pool in cluster B in region Y, the system will upgrade both node pools to image version 'AKSUbuntu-1804gen2containerd-2021.10.12'.

Contains response data for the listNext operation.

Contains response data for the list operation.

Defines values for Origin.
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user
system
user,system

Defines values for TargetType.
KnownTargetType can be used interchangeably with TargetType, this enum contains the known values that the service supports.

Known values supported by the service

Member: Skip the update of a member.
Group: Skip the update of a group.
Stage: Skip the update of an entire stage including the after stage wait.
AfterStageWait: Skip the update of the after stage wait of a certain stage.

Defines values for UpdateRunProvisioningState.
KnownUpdateRunProvisioningState can be used interchangeably with UpdateRunProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Resource has been created.
Failed: Resource creation failed.
Canceled: Resource creation was canceled.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listByFleetNext operation.

Contains response data for the listByFleet operation.

Contains response data for the skip operation.

Contains response data for the start operation.

Contains response data for the stop operation.

Defines values for UpdateState.
KnownUpdateState can be used interchangeably with UpdateState, this enum contains the known values that the service supports.

Known values supported by the service

NotStarted: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has not been started.
Running: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is running.
Stopping: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is being stopped.
Stopped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has stopped.
Skipped: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has been skipped.
Failed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has failed.
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed.

Known values of ActionType that the service accepts.

Known values of CreatedByType that the service accepts.

Known values of FleetMemberProvisioningState that the service accepts.

Known values of FleetProvisioningState that the service accepts.

Known values of FleetUpdateStrategyProvisioningState that the service accepts.

Known values of ManagedClusterUpgradeType that the service accepts.

Known values of ManagedServiceIdentityType that the service accepts.

Known values of NodeImageSelectionType that the service accepts.

Known values of Origin that the service accepts.

Known values of TargetType that the service accepts.

Known values of UpdateRunProvisioningState that the service accepts.

Known values of UpdateState that the service accepts.

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.