@azure/arm-containerservicefleet package

Access profile for the Fleet hub API server.

Affinity is a group of cluster affinity scheduling rules. More to be added.

Agent profile for the Fleet hub.

The node image upgrade to be applied to the target clusters in auto upgrade.

The AutoUpgradeProfile resource.

Optional parameters.

Interface representing a AutoUpgradeProfileOperations operations.

The properties of the AutoUpgradeProfile.

AutoUpgradeProfileStatus is the status of an auto upgrade profile.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a AutoUpgradeProfiles operations.

ClusterAffinity contains cluster affinity scheduling rules for the selected resources.

ClusterResourcePlacementSpec defines the desired state of ClusterResourcePlacement.

ClusterSelector

ClusterSelectorTerm

Optional parameters for the client.

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.

The Fleet resource.

One credential result item.

The Credential results response.

The FleetHubProfile configures the fleet hub.

A fleet managed namespace.

The properties of a fleet managed namespace that can be patched.

The properties of a fleet managed namespace.

Status information for the fleet managed namespace.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a FleetManagedNamespaces operations.

Optional parameters.

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

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

Status information for the fleet member

The type used for update operations of the FleetMember.

The updatable properties of the FleetMember.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a FleetMembers operations.

Optional parameters.

Properties of a Fleet that can be patched.

Fleet properties.

Status information for the fleet.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a FleetUpdateStrategies operations.

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

The properties of the UpdateStrategy.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Fleets operations.

Optional parameters.

A Gate controls the progression during a staged rollout, e.g. in an Update Run.

GateConfiguration is used to define where Gates should be placed within the Update Run.

Patch a Gate resource.

Properties of a Gate that can be patched.

A Gate controls the progression during a staged rollout, e.g. in an Update Run.

The target that the Gate is controlling, e.g. an Update Run. Exactly one of the properties objects will be set.

Optional parameters.

Optional parameters.

Interface representing a Gates operations.

Optional parameters.

GenerateResponse is the response of a generate request.

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

The update to be applied to the ManagedClusters.

The upgrade to apply to a ManagedCluster.

The namespace properties for the fleet managed namespace.

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

The status of a member update operation.

The network policy for the managed namespace.

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 and operation.

Optional parameters.

Interface representing a Operations operations.

Options for the byPage method

An interface that allows async iterable iteration both to completion and by page.

PlacementPolicy contains the rules to select target member clusters to place the selected resources. Note that only clusters that are both joined and satisfying the rules will be selected. You can only specify at most one of the two fields: ClusterNames and Affinity. If none is specified, all the joined clusters are selected.

The configuration profile for default ClusterResourcePlacement for placement.

The propagation to be used for provisioning the namespace among the fleet.

PropertySelector helps user specify property requirements when picking clusters for resource placement.

PropertySelectorRequirement is a specific property requirement when picking clusters for resource placement.

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 resource quota for the managed namespace.

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.

Toleration allows ClusterResourcePlacement to tolerate any taint that matches the triple <key,value,effect> using the matching operator <operator>.

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 status of the Gate, as represented in the Update Run.

The properties of the Update Run that the Gate is targeting.

The properties of the UpdateRun.

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.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a UpdateRuns operations.

Optional parameters.

Optional parameters.

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.

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

Action if the Namespace with the same name already exists.
KnownAdoptionPolicy can be used interchangeably with AdoptionPolicy, this enum contains the known values that the service supports.

Known values supported by the service

Never: If the Namespace already exists, do not take over the existing Namespace to be managed by ARM.
IfIdentical: If there is an identical Namespace, take over the existing Namespace to be managed by ARM.
Always: Always take over the existing Namespace to be managed by ARM, even if it is not identical.

AutoUpgradeLastTriggerStatus is the status of the last AutoUpgrade trigger (attempt to automatically create and start UpdateRun when there are new released versions) of an auto upgrade profile.
KnownAutoUpgradeLastTriggerStatus can be used interchangeably with AutoUpgradeLastTriggerStatus, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The last AutoUpgrade trigger was succeeded.
Failed: The last AutoUpgrade trigger failed.

The node image upgrade type.
KnownAutoUpgradeNodeImageSelectionType can be used interchangeably with AutoUpgradeNodeImageSelectionType, 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'.

The provisioning state of the AutoUpgradeProfile resource.
KnownAutoUpgradeProfileProvisioningState can be used interchangeably with AutoUpgradeProfileProvisioningState, 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.

The supported values for cloud setting as a string literal type

An interface that describes a page of results.

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

Delete options for the ARM managed namespace.
KnownDeletePolicy can be used interchangeably with DeletePolicy, this enum contains the known values that the service supports.

Known values supported by the service

Keep: Delete the ARM resource but keep the Namespace.
Delete: Delete both ARM resource and Namespace.

The provisioning state of the fleet managed namespace resource
KnownFleetManagedNamespaceProvisioningState can be used interchangeably with FleetManagedNamespaceProvisioningState, 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 managed namespace being created.
Updating: The provisioning state of a fleet managed namespace being updated.
Deleting: The provisioning state of a fleet managed namespace being deleted.

The provisioning state of the last accepted operation.
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.

The provisioning state of the last accepted operation.
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.

The provisioning state of the UpdateStrategy resource.
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.

The provisioning state of the Gate resource.
KnownGateProvisioningState can be used interchangeably with GateProvisioningState, 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.

The state of the Gate.
KnownGateState can be used interchangeably with GateState, this enum contains the known values that the service supports.

Known values supported by the service

Pending: A Pending Gate will continue to block the staged rollout process it is controlling.
Skipped: A Skipped Gate means that the staged rollout process it is controlling was skipped.
Completed: An Completed Gate allows the staged rollout process to continue.

The type of the Gate determines how it is completed.
KnownGateType can be used interchangeably with GateType, this enum contains the known values that the service supports.

Known values supported by the service

Approval: An approval gate is completed by setting its state to be Completed.

A label selector operator is the set of operators that can be used in a selector requirement.
KnownLabelSelectorOperator can be used interchangeably with LabelSelectorOperator, this enum contains the known values that the service supports.

Known values supported by the service

In: Label Selector Operator In
NotIn: Label Selector Operator NotIn
Exists: Label Selector Operator Exists
DoesNotExist: Label Selector Operator DoesNotExist

The type of upgrade to perform when targeting ManagedClusters.
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.

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None: No managed identity.
SystemAssigned: System assigned managed identity.
UserAssigned: User assigned managed identity.
SystemAssigned, UserAssigned: System and user assigned managed identity.

The node image upgrade type.
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'.
Custom: Upgrade the nodes to the custom image versions. When set, update run will use node image versions provided in customNodeImageVersions to upgrade the nodes. If set, customNodeImageVersions must not be empty.

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

PlacementType identifies the type of placement.
KnownPlacementType can be used interchangeably with PlacementType, this enum contains the known values that the service supports.

Known values supported by the service

PickAll: PickAll picks all clusters that satisfy the rules.
PickFixed: PickFixed picks a fixed set of clusters.

The possible values representing different network policy rules.
KnownPolicyRule can be used interchangeably with PolicyRule, this enum contains the known values that the service supports.

Known values supported by the service

AllowAll: Allow all network traffic.
DenyAll: Deny all network traffic.
AllowSameNamespace: Allow traffic within the same namespace.

How the namespace will be provisioned among the fleet members.
KnownPropagationType can be used interchangeably with PropagationType, this enum contains the known values that the service supports.

Known values supported by the service

Placement: Using ClusterResourcePlacement.

PropertySelectorOperator is the operator that can be used with PropertySelectorRequirements.
KnownPropertySelectorOperator can be used interchangeably with PropertySelectorOperator, this enum contains the known values that the service supports.

Known values supported by the service

Gt: Gt dictates Fleet to select cluster if its observed value of a given property is greater than the value specified in the requirement.
Ge: Ge dictates Fleet to select cluster if its observed value of a given property is greater than or equal to the value specified in the requirement.
Eq: Eq dictates Fleet to select cluster if its observed value of a given property is equal to the values specified in the requirement.
Ne: Ne dictates Fleet to select cluster if its observed value of a given property is not equal to the values specified in the requirement.
Lt: Lt dictates Fleet to select cluster if its observed value of a given property is less than the value specified in the requirement.
Le: Le dictates Fleet to select cluster if its observed value of a given property is less than or equal to the value specified in the requirement.

TaintEffect
KnownTaintEffect can be used interchangeably with TaintEffect, this enum contains the known values that the service supports.

Known values supported by the service

NoSchedule: Do not allow new pods to schedule onto the node unless they tolerate the taint, but allow all pods submitted to Kubelet without going through the scheduler to start, and allow all already-running pods to continue running. Enforced by the scheduler.

The target type of a skip request.
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.

Whether the Gate is placed before or after the target.
KnownTiming can be used interchangeably with Timing, this enum contains the known values that the service supports.

Known values supported by the service

Before: The Gate is before the target.
After: The Gate is after the target.

A toleration operator is the set of operators that can be used in a toleration.
KnownTolerationOperator can be used interchangeably with TolerationOperator, this enum contains the known values that the service supports.

Known values supported by the service

Exists: Toleration Operator Exists
Equal: Toleration Operator Equal

The provisioning state of the UpdateRun resource.
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.

The state of the UpdateRun, UpdateStage, UpdateGroup, or MemberUpdate.
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.
Pending: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that is pending.
Completed: The state of an UpdateRun/UpdateStage/UpdateGroup/MemberUpdate that has completed.

Configuration of how auto upgrade will be run.
KnownUpgradeChannel can be used interchangeably with UpgradeChannel, this enum contains the known values that the service supports.

Known values supported by the service

Stable: Upgrades the clusters kubernetes version to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster runs version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, the cluster upgrades to 1.18.6.
Rapid: Upgrades the clusters kubernetes version to the latest supported patch release on the latest supported minor version.
NodeImage: Upgrade node image version of the clusters.
TargetKubernetesVersion: Upgrades the clusters Kubernetes version to the latest supported patch version of the specified target Kubernetes version. For information on the behavior of update run for Kubernetes version upgrade, see https://learn.microsoft.com/en-us/azure/kubernetes-fleet/update-orchestration?tabs=azure-portal

An enum to describe Azure Cloud environments.

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

Action if the Namespace with the same name already exists.

AutoUpgradeLastTriggerStatus is the status of the last AutoUpgrade trigger (attempt to automatically create and start UpdateRun when there are new released versions) of an auto upgrade profile.

The node image upgrade type.

The provisioning state of the AutoUpgradeProfile resource.

The kind of entity that created the resource.

Delete options for the ARM managed namespace.

The provisioning state of the fleet managed namespace resource

The provisioning state of the last accepted operation.

The provisioning state of the last accepted operation.

The provisioning state of the UpdateStrategy resource.

The provisioning state of the Gate resource.

The state of the Gate.

The type of the Gate determines how it is completed.

A label selector operator is the set of operators that can be used in a selector requirement.

The type of upgrade to perform when targeting ManagedClusters.

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

The node image upgrade type.

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

PlacementType identifies the type of placement.

The possible values representing different network policy rules.

How the namespace will be provisioned among the fleet members.

PropertySelectorOperator is the operator that can be used with PropertySelectorRequirements.

TaintEffect

The target type of a skip request.

Whether the Gate is placed before or after the target.

A toleration operator is the set of operators that can be used in a toleration.

The provisioning state of the UpdateRun resource.

The state of the UpdateRun, UpdateStage, UpdateGroup, or MemberUpdate.

Configuration of how auto upgrade will be run.

Azure Kubernetes Fleet Manager api versions.

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.