containerservice.azure.com/v1api20250301
APIVersion
Value | Description |
---|---|
“2025-03-01” |
Fleet
Generator information: - Generated from: /containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2025-03-01/fleets.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}
Used by: FleetList.
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ObjectMeta | ||
spec | Fleet_Spec Optional |
|
status | Fleet_STATUS Optional |
Fleet_Spec
Property | Description | Type |
---|---|---|
azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
hubProfile | The FleetHubProfile configures the Fleet’s hub. | FleetHubProfile Optional |
identity | Managed identity. | ManagedServiceIdentity Optional |
location | The geo-location where the resource lives | string Required |
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | FleetOperatorSpec Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
tags | Resource tags. | map[string]string Optional |
Fleet_STATUS
Property | Description | Type |
---|---|---|
conditions | The observed state of the resource | conditions.Condition[] Optional |
eTag | If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. | string Optional |
hubProfile | The FleetHubProfile configures the Fleet’s hub. | FleetHubProfile_STATUS Optional |
id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
identity | Managed identity. | ManagedServiceIdentity_STATUS Optional |
location | The geo-location where the resource lives | string Optional |
name | The name of the resource | string Optional |
provisioningState | The status of the last operation. | FleetProvisioningState_STATUS Optional |
status | Status information for the fleet. | FleetStatus_STATUS Optional |
systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
tags | Resource tags. | map[string]string Optional |
type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
FleetList
Generator information: - Generated from: /containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2025-03-01/fleets.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ListMeta | ||
items | Fleet[] Optional |
FleetsAutoUpgradeProfile
Generator information: - Generated from: /containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2025-03-01/fleets.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/autoUpgradeProfiles/{autoUpgradeProfileName}
Used by: FleetsAutoUpgradeProfileList.
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ObjectMeta | ||
spec | FleetsAutoUpgradeProfile_Spec Optional |
|
status | FleetsAutoUpgradeProfile_STATUS Optional |
FleetsAutoUpgradeProfile_Spec
Property | Description | Type |
---|---|---|
azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
channel | Configures how auto-upgrade will be run. | UpgradeChannel Required |
disabled | If set to False: the auto upgrade has effect - target managed clusters will be upgraded on schedule. If set to True: the auto upgrade has no effect - no upgrade will be run on the target managed clusters. This is a boolean and not an enum because enabled/disabled are all available states of the auto upgrade profile. By default, this is set to False. | bool Optional |
nodeImageSelection | The node image upgrade to be applied to the target clusters in auto upgrade. | AutoUpgradeNodeImageSelection Optional |
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | FleetsAutoUpgradeProfileOperatorSpec Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a containerservice.azure.com/Fleet resource | genruntime.KnownResourceReference Required |
updateStrategyReference | The resource id of the UpdateStrategy resource to reference. If not specified, the auto upgrade will run on all clusters which are members of the fleet. | genruntime.ResourceReference Optional |
FleetsAutoUpgradeProfile_STATUS
Property | Description | Type |
---|---|---|
autoUpgradeProfileStatus | The status of the auto upgrade profile. | AutoUpgradeProfileStatus_STATUS Optional |
channel | Configures how auto-upgrade will be run. | UpgradeChannel_STATUS Optional |
conditions | The observed state of the resource | conditions.Condition[] Optional |
disabled | If set to False: the auto upgrade has effect - target managed clusters will be upgraded on schedule. If set to True: the auto upgrade has no effect - no upgrade will be run on the target managed clusters. This is a boolean and not an enum because enabled/disabled are all available states of the auto upgrade profile. By default, this is set to False. | bool Optional |
eTag | If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. | string Optional |
id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
name | The name of the resource | string Optional |
nodeImageSelection | The node image upgrade to be applied to the target clusters in auto upgrade. | AutoUpgradeNodeImageSelection_STATUS Optional |
provisioningState | The provisioning state of the AutoUpgradeProfile resource. | AutoUpgradeProfileProvisioningState_STATUS Optional |
systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
updateStrategyId | The resource id of the UpdateStrategy resource to reference. If not specified, the auto upgrade will run on all clusters which are members of the fleet. | string Optional |
FleetsAutoUpgradeProfileList
Generator information: - Generated from: /containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2025-03-01/fleets.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/autoUpgradeProfiles/{autoUpgradeProfileName}
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ListMeta | ||
items | FleetsAutoUpgradeProfile[] Optional |
FleetsMember
Generator information: - Generated from: /containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2025-03-01/fleets.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/members/{fleetMemberName}
Used by: FleetsMemberList.
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ObjectMeta | ||
spec | FleetsMember_Spec Optional |
|
status | FleetsMember_STATUS Optional |
FleetsMember_Spec
Property | Description | Type |
---|---|---|
azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
clusterResourceReference | The ARM resource id of the cluster that joins the Fleet. Must be a valid Azure resource id. e.g.: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{clusterName}’. | genruntime.ResourceReference Required |
group | The group this member belongs to for multi-cluster update management. | string Optional |
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | FleetsMemberOperatorSpec Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a containerservice.azure.com/Fleet resource | genruntime.KnownResourceReference Required |
FleetsMember_STATUS
Property | Description | Type |
---|---|---|
clusterResourceId | The ARM resource id of the cluster that joins the Fleet. Must be a valid Azure resource id. e.g.: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{clusterName}’. | string Optional |
conditions | The observed state of the resource | conditions.Condition[] Optional |
eTag | If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. | string Optional |
group | The group this member belongs to for multi-cluster update management. | string Optional |
id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
name | The name of the resource | string Optional |
provisioningState | The status of the last operation. | FleetMemberProvisioningState_STATUS Optional |
status | Status information of the last operation for fleet member. | FleetMemberStatus_STATUS Optional |
systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
FleetsMemberList
Generator information: - Generated from: /containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2025-03-01/fleets.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/members/{fleetMemberName}
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ListMeta | ||
items | FleetsMember[] Optional |
FleetsUpdateRun
Generator information: - Generated from: /containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2025-03-01/fleets.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateRuns/{updateRunName}
Used by: FleetsUpdateRunList.
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ObjectMeta | ||
spec | FleetsUpdateRun_Spec Optional |
|
status | FleetsUpdateRun_STATUS Optional |
FleetsUpdateRun_Spec
Property | Description | Type |
---|---|---|
azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
managedClusterUpdate | The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started. | ManagedClusterUpdate Required |
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | FleetsUpdateRunOperatorSpec Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a containerservice.azure.com/Fleet resource | genruntime.KnownResourceReference Required |
strategy | The strategy defines the order in which the clusters will be updated. If not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members. The strategy of the UpdateRun can be modified until the run is started. | UpdateRunStrategy Optional |
updateStrategyReference | The resource id of the FleetUpdateStrategy resource to reference. When creating a new run, there are three ways to define a strategy for the run: 1. Define a new strategy in place: Set the “strategy” field. 2. Use an existing strategy: Set the “updateStrategyId” field. (since 2023-08-15-preview) 3. Use the default strategy to update all the members one by one: Leave both “updateStrategyId” and “strategy” unset. (since 2023-08-15-preview) Setting both “updateStrategyId” and “strategy” is invalid. UpdateRuns created by “updateStrategyId” snapshot the referenced UpdateStrategy at the time of creation and store it in the “strategy” field. Subsequent changes to the referenced FleetUpdateStrategy resource do not propagate. UpdateRunStrategy changes can be made directly on the “strategy” field before launching the UpdateRun. | genruntime.ResourceReference Optional |
FleetsUpdateRun_STATUS
Property | Description | Type |
---|---|---|
autoUpgradeProfileId | AutoUpgradeProfileId is the id of an auto upgrade profile resource. | string Optional |
conditions | The observed state of the resource | conditions.Condition[] Optional |
eTag | If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. | string Optional |
id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
managedClusterUpdate | The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started. | ManagedClusterUpdate_STATUS Optional |
name | The name of the resource | string Optional |
provisioningState | The provisioning state of the UpdateRun resource. | UpdateRunProvisioningState_STATUS Optional |
status | The status of the UpdateRun. | UpdateRunStatus_STATUS Optional |
strategy | The strategy defines the order in which the clusters will be updated. If not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members. The strategy of the UpdateRun can be modified until the run is started. | UpdateRunStrategy_STATUS Optional |
systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
updateStrategyId | The resource id of the FleetUpdateStrategy resource to reference. When creating a new run, there are three ways to define a strategy for the run: 1. Define a new strategy in place: Set the “strategy” field. 2. Use an existing strategy: Set the “updateStrategyId” field. (since 2023-08-15-preview) 3. Use the default strategy to update all the members one by one: Leave both “updateStrategyId” and “strategy” unset. (since 2023-08-15-preview) Setting both “updateStrategyId” and “strategy” is invalid. UpdateRuns created by “updateStrategyId” snapshot the referenced UpdateStrategy at the time of creation and store it in the “strategy” field. Subsequent changes to the referenced FleetUpdateStrategy resource do not propagate. UpdateRunStrategy changes can be made directly on the “strategy” field before launching the UpdateRun. | string Optional |
FleetsUpdateRunList
Generator information: - Generated from: /containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2025-03-01/fleets.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateRuns/{updateRunName}
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ListMeta | ||
items | FleetsUpdateRun[] Optional |
FleetsUpdateStrategy
Generator information: - Generated from: /containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2025-03-01/fleets.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateStrategies/{updateStrategyName}
Used by: FleetsUpdateStrategyList.
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ObjectMeta | ||
spec | FleetsUpdateStrategy_Spec Optional |
|
status | FleetsUpdateStrategy_STATUS Optional |
FleetsUpdateStrategy_Spec
Property | Description | Type |
---|---|---|
azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | FleetsUpdateStrategyOperatorSpec Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a containerservice.azure.com/Fleet resource | genruntime.KnownResourceReference Required |
strategy | Defines the update sequence of the clusters. | UpdateRunStrategy Required |
FleetsUpdateStrategy_STATUS
Property | Description | Type |
---|---|---|
conditions | The observed state of the resource | conditions.Condition[] Optional |
eTag | If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. | string Optional |
id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
name | The name of the resource | string Optional |
provisioningState | The provisioning state of the UpdateStrategy resource. | FleetUpdateStrategyProvisioningState_STATUS Optional |
strategy | Defines the update sequence of the clusters. | UpdateRunStrategy_STATUS Optional |
systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
FleetsUpdateStrategyList
Generator information: - Generated from: /containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2025-03-01/fleets.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateStrategies/{updateStrategyName}
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ListMeta | ||
items | FleetsUpdateStrategy[] Optional |
Fleet_Spec
Used by: Fleet.
Property | Description | Type |
---|---|---|
azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
hubProfile | The FleetHubProfile configures the Fleet’s hub. | FleetHubProfile Optional |
identity | Managed identity. | ManagedServiceIdentity Optional |
location | The geo-location where the resource lives | string Required |
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | FleetOperatorSpec Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
tags | Resource tags. | map[string]string Optional |
Fleet_STATUS
The Fleet resource.
Used by: Fleet.
Property | Description | Type |
---|---|---|
conditions | The observed state of the resource | conditions.Condition[] Optional |
eTag | If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. | string Optional |
hubProfile | The FleetHubProfile configures the Fleet’s hub. | FleetHubProfile_STATUS Optional |
id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
identity | Managed identity. | ManagedServiceIdentity_STATUS Optional |
location | The geo-location where the resource lives | string Optional |
name | The name of the resource | string Optional |
provisioningState | The status of the last operation. | FleetProvisioningState_STATUS Optional |
status | Status information for the fleet. | FleetStatus_STATUS Optional |
systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
tags | Resource tags. | map[string]string Optional |
type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
FleetsAutoUpgradeProfile_Spec
Used by: FleetsAutoUpgradeProfile.
Property | Description | Type |
---|---|---|
azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
channel | Configures how auto-upgrade will be run. | UpgradeChannel Required |
disabled | If set to False: the auto upgrade has effect - target managed clusters will be upgraded on schedule. If set to True: the auto upgrade has no effect - no upgrade will be run on the target managed clusters. This is a boolean and not an enum because enabled/disabled are all available states of the auto upgrade profile. By default, this is set to False. | bool Optional |
nodeImageSelection | The node image upgrade to be applied to the target clusters in auto upgrade. | AutoUpgradeNodeImageSelection Optional |
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | FleetsAutoUpgradeProfileOperatorSpec Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a containerservice.azure.com/Fleet resource | genruntime.KnownResourceReference Required |
updateStrategyReference | The resource id of the UpdateStrategy resource to reference. If not specified, the auto upgrade will run on all clusters which are members of the fleet. | genruntime.ResourceReference Optional |
FleetsAutoUpgradeProfile_STATUS
Used by: FleetsAutoUpgradeProfile.
Property | Description | Type |
---|---|---|
autoUpgradeProfileStatus | The status of the auto upgrade profile. | AutoUpgradeProfileStatus_STATUS Optional |
channel | Configures how auto-upgrade will be run. | UpgradeChannel_STATUS Optional |
conditions | The observed state of the resource | conditions.Condition[] Optional |
disabled | If set to False: the auto upgrade has effect - target managed clusters will be upgraded on schedule. If set to True: the auto upgrade has no effect - no upgrade will be run on the target managed clusters. This is a boolean and not an enum because enabled/disabled are all available states of the auto upgrade profile. By default, this is set to False. | bool Optional |
eTag | If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. | string Optional |
id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
name | The name of the resource | string Optional |
nodeImageSelection | The node image upgrade to be applied to the target clusters in auto upgrade. | AutoUpgradeNodeImageSelection_STATUS Optional |
provisioningState | The provisioning state of the AutoUpgradeProfile resource. | AutoUpgradeProfileProvisioningState_STATUS Optional |
systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
updateStrategyId | The resource id of the UpdateStrategy resource to reference. If not specified, the auto upgrade will run on all clusters which are members of the fleet. | string Optional |
FleetsMember_Spec
Used by: FleetsMember.
Property | Description | Type |
---|---|---|
azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
clusterResourceReference | The ARM resource id of the cluster that joins the Fleet. Must be a valid Azure resource id. e.g.: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{clusterName}’. | genruntime.ResourceReference Required |
group | The group this member belongs to for multi-cluster update management. | string Optional |
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | FleetsMemberOperatorSpec Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a containerservice.azure.com/Fleet resource | genruntime.KnownResourceReference Required |
FleetsMember_STATUS
Used by: FleetsMember.
Property | Description | Type |
---|---|---|
clusterResourceId | The ARM resource id of the cluster that joins the Fleet. Must be a valid Azure resource id. e.g.: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{clusterName}’. | string Optional |
conditions | The observed state of the resource | conditions.Condition[] Optional |
eTag | If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. | string Optional |
group | The group this member belongs to for multi-cluster update management. | string Optional |
id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
name | The name of the resource | string Optional |
provisioningState | The status of the last operation. | FleetMemberProvisioningState_STATUS Optional |
status | Status information of the last operation for fleet member. | FleetMemberStatus_STATUS Optional |
systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
FleetsUpdateRun_Spec
Used by: FleetsUpdateRun.
Property | Description | Type |
---|---|---|
azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
managedClusterUpdate | The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started. | ManagedClusterUpdate Required |
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | FleetsUpdateRunOperatorSpec Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a containerservice.azure.com/Fleet resource | genruntime.KnownResourceReference Required |
strategy | The strategy defines the order in which the clusters will be updated. If not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members. The strategy of the UpdateRun can be modified until the run is started. | UpdateRunStrategy Optional |
updateStrategyReference | The resource id of the FleetUpdateStrategy resource to reference. When creating a new run, there are three ways to define a strategy for the run: 1. Define a new strategy in place: Set the “strategy” field. 2. Use an existing strategy: Set the “updateStrategyId” field. (since 2023-08-15-preview) 3. Use the default strategy to update all the members one by one: Leave both “updateStrategyId” and “strategy” unset. (since 2023-08-15-preview) Setting both “updateStrategyId” and “strategy” is invalid. UpdateRuns created by “updateStrategyId” snapshot the referenced UpdateStrategy at the time of creation and store it in the “strategy” field. Subsequent changes to the referenced FleetUpdateStrategy resource do not propagate. UpdateRunStrategy changes can be made directly on the “strategy” field before launching the UpdateRun. | genruntime.ResourceReference Optional |
FleetsUpdateRun_STATUS
Used by: FleetsUpdateRun.
Property | Description | Type |
---|---|---|
autoUpgradeProfileId | AutoUpgradeProfileId is the id of an auto upgrade profile resource. | string Optional |
conditions | The observed state of the resource | conditions.Condition[] Optional |
eTag | If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. | string Optional |
id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
managedClusterUpdate | The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started. | ManagedClusterUpdate_STATUS Optional |
name | The name of the resource | string Optional |
provisioningState | The provisioning state of the UpdateRun resource. | UpdateRunProvisioningState_STATUS Optional |
status | The status of the UpdateRun. | UpdateRunStatus_STATUS Optional |
strategy | The strategy defines the order in which the clusters will be updated. If not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members. The strategy of the UpdateRun can be modified until the run is started. | UpdateRunStrategy_STATUS Optional |
systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
updateStrategyId | The resource id of the FleetUpdateStrategy resource to reference. When creating a new run, there are three ways to define a strategy for the run: 1. Define a new strategy in place: Set the “strategy” field. 2. Use an existing strategy: Set the “updateStrategyId” field. (since 2023-08-15-preview) 3. Use the default strategy to update all the members one by one: Leave both “updateStrategyId” and “strategy” unset. (since 2023-08-15-preview) Setting both “updateStrategyId” and “strategy” is invalid. UpdateRuns created by “updateStrategyId” snapshot the referenced UpdateStrategy at the time of creation and store it in the “strategy” field. Subsequent changes to the referenced FleetUpdateStrategy resource do not propagate. UpdateRunStrategy changes can be made directly on the “strategy” field before launching the UpdateRun. | string Optional |
FleetsUpdateStrategy_Spec
Used by: FleetsUpdateStrategy.
Property | Description | Type |
---|---|---|
azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | FleetsUpdateStrategyOperatorSpec Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a containerservice.azure.com/Fleet resource | genruntime.KnownResourceReference Required |
strategy | Defines the update sequence of the clusters. | UpdateRunStrategy Required |
FleetsUpdateStrategy_STATUS
Used by: FleetsUpdateStrategy.
Property | Description | Type |
---|---|---|
conditions | The observed state of the resource | conditions.Condition[] Optional |
eTag | If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. | string Optional |
id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
name | The name of the resource | string Optional |
provisioningState | The provisioning state of the UpdateStrategy resource. | FleetUpdateStrategyProvisioningState_STATUS Optional |
strategy | Defines the update sequence of the clusters. | UpdateRunStrategy_STATUS Optional |
systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
AutoUpgradeNodeImageSelection
The node image upgrade to be applied to the target clusters in auto upgrade.
Used by: FleetsAutoUpgradeProfile_Spec.
Property | Description | Type |
---|---|---|
type | The node image upgrade type. | AutoUpgradeNodeImageSelectionType Required |
AutoUpgradeNodeImageSelection_STATUS
The node image upgrade to be applied to the target clusters in auto upgrade.
Used by: FleetsAutoUpgradeProfile_STATUS.
Property | Description | Type |
---|---|---|
type | The node image upgrade type. | AutoUpgradeNodeImageSelectionType_STATUS Optional |
AutoUpgradeProfileProvisioningState_STATUS
The provisioning state of the AutoUpgradeProfile resource.
Used by: FleetsAutoUpgradeProfile_STATUS.
Value | Description |
---|---|
“Canceled” | |
“Failed” | |
“Succeeded” |
AutoUpgradeProfileStatus_STATUS
AutoUpgradeProfileStatus is the status of an auto upgrade profile.
Used by: FleetsAutoUpgradeProfile_STATUS.
Property | Description | Type |
---|---|---|
lastTriggeredAt | The UTC time of the last attempt to automatically create and start an UpdateRun as triggered by the release of new versions. | string Optional |
lastTriggerError | The error details of the last trigger. | ErrorDetail_STATUS Optional |
lastTriggerStatus | The status of the last AutoUpgrade trigger. | AutoUpgradeLastTriggerStatus_STATUS Optional |
lastTriggerUpgradeVersions | The target Kubernetes version or node image versions of the last trigger. | string[] Optional |
FleetHubProfile
The FleetHubProfile configures the fleet hub.
Used by: Fleet_Spec.
Property | Description | Type |
---|---|---|
agentProfile | The agent profile for the Fleet hub. | AgentProfile Optional |
apiServerAccessProfile | The access profile for the Fleet hub API server. | APIServerAccessProfile Optional |
dnsPrefix | DNS prefix used to create the FQDN for the Fleet hub. | string Optional |
FleetHubProfile_STATUS
The FleetHubProfile configures the fleet hub.
Used by: Fleet_STATUS.
Property | Description | Type |
---|---|---|
agentProfile | The agent profile for the Fleet hub. | AgentProfile_STATUS Optional |
apiServerAccessProfile | The access profile for the Fleet hub API server. | APIServerAccessProfile_STATUS Optional |
dnsPrefix | DNS prefix used to create the FQDN for the Fleet hub. | string Optional |
fqdn | The FQDN of the Fleet hub. | string Optional |
kubernetesVersion | The Kubernetes version of the Fleet hub. | string Optional |
portalFqdn | The Azure Portal FQDN of the Fleet hub. | string Optional |
FleetMemberProvisioningState_STATUS
The provisioning state of the last accepted operation.
Used by: FleetsMember_STATUS.
Value | Description |
---|---|
“Canceled” | |
“Failed” | |
“Joining” | |
“Leaving” | |
“Succeeded” | |
“Updating” |
FleetMemberStatus_STATUS
Status information for the fleet member
Used by: FleetsMember_STATUS.
Property | Description | Type |
---|---|---|
lastOperationError | The last operation error of the fleet member | ErrorDetail_STATUS Optional |
lastOperationId | The last operation ID for the fleet member | string Optional |
FleetOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Fleet_Spec.
Property | Description | Type |
---|---|---|
configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
secrets | configures where to place Azure generated secrets. | FleetOperatorSecrets Optional |
FleetProvisioningState_STATUS
The provisioning state of the last accepted operation.
Used by: Fleet_STATUS.
Value | Description |
---|---|
“Canceled” | |
“Creating” | |
“Deleting” | |
“Failed” | |
“Succeeded” | |
“Updating” |
FleetsAutoUpgradeProfileOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: FleetsAutoUpgradeProfile_Spec.
Property | Description | Type |
---|---|---|
configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
FleetsMemberOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: FleetsMember_Spec.
Property | Description | Type |
---|---|---|
configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
FleetStatus_STATUS
Status information for the fleet.
Used by: Fleet_STATUS.
Property | Description | Type |
---|---|---|
lastOperationError | The last operation error for the fleet. | ErrorDetail_STATUS Optional |
lastOperationId | The last operation ID for the fleet. | string Optional |
FleetsUpdateRunOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: FleetsUpdateRun_Spec.
Property | Description | Type |
---|---|---|
configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
FleetsUpdateStrategyOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: FleetsUpdateStrategy_Spec.
Property | Description | Type |
---|---|---|
configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
FleetUpdateStrategyProvisioningState_STATUS
The provisioning state of the UpdateStrategy resource.
Used by: FleetsUpdateStrategy_STATUS.
Value | Description |
---|---|
“Canceled” | |
“Failed” | |
“Succeeded” |
ManagedClusterUpdate
The update to be applied to the ManagedClusters.
Used by: FleetsUpdateRun_Spec.
Property | Description | Type |
---|---|---|
nodeImageSelection | The node image upgrade to be applied to the target nodes in update run. | NodeImageSelection Optional |
upgrade | The upgrade to apply to the ManagedClusters. | ManagedClusterUpgradeSpec Required |
ManagedClusterUpdate_STATUS
The update to be applied to the ManagedClusters.
Used by: FleetsUpdateRun_STATUS.
Property | Description | Type |
---|---|---|
nodeImageSelection | The node image upgrade to be applied to the target nodes in update run. | NodeImageSelection_STATUS Optional |
upgrade | The upgrade to apply to the ManagedClusters. | ManagedClusterUpgradeSpec_STATUS Optional |
ManagedServiceIdentity
Managed service identity (system assigned and/or user assigned identities)
Used by: Fleet_Spec.
Property | Description | Type |
---|---|---|
type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | ManagedServiceIdentityType Required |
userAssignedIdentities | UserAssignedIdentityDetails[] Optional |
ManagedServiceIdentity_STATUS
Managed service identity (system assigned and/or user assigned identities)
Used by: Fleet_STATUS.
Property | Description | Type |
---|---|---|
principalId | The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. | string Optional |
tenantId | The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. | string Optional |
type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | ManagedServiceIdentityType_STATUS Optional |
userAssignedIdentities | map[string]CommonUserAssignedIdentity_STATUS Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: Fleet_STATUS, FleetsAutoUpgradeProfile_STATUS, FleetsMember_STATUS, FleetsUpdateRun_STATUS, and FleetsUpdateStrategy_STATUS.
Property | Description | Type |
---|---|---|
createdAt | The timestamp of resource creation (UTC). | string Optional |
createdBy | The identity that created the resource. | string Optional |
createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
lastModifiedAt | The timestamp of resource last modification (UTC) | string Optional |
lastModifiedBy | The identity that last modified the resource. | string Optional |
lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
UpdateRunProvisioningState_STATUS
The provisioning state of the UpdateRun resource.
Used by: FleetsUpdateRun_STATUS.
Value | Description |
---|---|
“Canceled” | |
“Failed” | |
“Succeeded” |
UpdateRunStatus_STATUS
The status of a UpdateRun.
Used by: FleetsUpdateRun_STATUS.
Property | Description | Type |
---|---|---|
nodeImageSelection | The node image upgrade specs for the update run. It is only set in update run when NodeImageSelection.type is Consistent . |
NodeImageSelectionStatus_STATUS Optional |
stages | The stages composing an update run. Stages are run sequentially withing an UpdateRun. | UpdateStageStatus_STATUS[] Optional |
status | The status of the UpdateRun. | UpdateStatus_STATUS Optional |
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.
Used by: FleetsUpdateRun_Spec, and FleetsUpdateStrategy_Spec.
Property | Description | Type |
---|---|---|
stages | The list of stages that compose this update run. Min size: 1. | UpdateStage[] Required |
UpdateRunStrategy_STATUS
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.
Used by: FleetsUpdateRun_STATUS, and FleetsUpdateStrategy_STATUS.
Property | Description | Type |
---|---|---|
stages | The list of stages that compose this update run. Min size: 1. | UpdateStage_STATUS[] Optional |
UpgradeChannel
Configuration of how auto upgrade will be run.
Used by: FleetsAutoUpgradeProfile_Spec.
Value | Description |
---|---|
“NodeImage” | |
“Rapid” | |
“Stable” |
UpgradeChannel_STATUS
Configuration of how auto upgrade will be run.
Used by: FleetsAutoUpgradeProfile_STATUS.
Value | Description |
---|---|
“NodeImage” | |
“Rapid” | |
“Stable” |
AgentProfile
Agent profile for the Fleet hub.
Used by: FleetHubProfile.
Property | Description | Type |
---|---|---|
subnetReference | The ID of the subnet which the Fleet hub node will join on startup. If this is not specified, a vnet and subnet will be generated and used. | genruntime.ResourceReference Optional |
vmSize | The virtual machine size of the Fleet hub. | string Optional |
AgentProfile_STATUS
Agent profile for the Fleet hub.
Used by: FleetHubProfile_STATUS.
Property | Description | Type |
---|---|---|
subnetId | The ID of the subnet which the Fleet hub node will join on startup. If this is not specified, a vnet and subnet will be generated and used. | string Optional |
vmSize | The virtual machine size of the Fleet hub. | string Optional |
APIServerAccessProfile
Access profile for the Fleet hub API server.
Used by: FleetHubProfile.
Property | Description | Type |
---|---|---|
enablePrivateCluster | Whether to create the Fleet hub as a private cluster or not. | bool Optional |
enableVnetIntegration | Whether to enable apiserver vnet integration for the Fleet hub or not. | bool Optional |
subnetReference | The subnet to be used when apiserver vnet integration is enabled. It is required when creating a new Fleet with BYO vnet. | genruntime.ResourceReference Optional |
APIServerAccessProfile_STATUS
Access profile for the Fleet hub API server.
Used by: FleetHubProfile_STATUS.
Property | Description | Type |
---|---|---|
enablePrivateCluster | Whether to create the Fleet hub as a private cluster or not. | bool Optional |
enableVnetIntegration | Whether to enable apiserver vnet integration for the Fleet hub or not. | bool Optional |
subnetId | The subnet to be used when apiserver vnet integration is enabled. It is required when creating a new Fleet with BYO vnet. | string Optional |
AutoUpgradeLastTriggerStatus_STATUS
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.
Used by: AutoUpgradeProfileStatus_STATUS.
Value | Description |
---|---|
“Failed” | |
“Succeeded” |
AutoUpgradeNodeImageSelectionType
The node image upgrade type.
Used by: AutoUpgradeNodeImageSelection.
Value | Description |
---|---|
“Consistent” | |
“Latest” |
AutoUpgradeNodeImageSelectionType_STATUS
The node image upgrade type.
Used by: AutoUpgradeNodeImageSelection_STATUS.
Value | Description |
---|---|
“Consistent” | |
“Latest” |
CommonUserAssignedIdentity_STATUS
User assigned identity properties
Used by: ManagedServiceIdentity_STATUS.
Property | Description | Type |
---|---|---|
clientId | The client ID of the assigned identity. | string Optional |
principalId | The principal ID of the assigned identity. | string Optional |
ErrorDetail_STATUS
The error detail.
Used by: AutoUpgradeProfileStatus_STATUS, FleetMemberStatus_STATUS, FleetStatus_STATUS, and UpdateStatus_STATUS.
Property | Description | Type |
---|---|---|
additionalInfo | The error additional info. | ErrorAdditionalInfo_STATUS[] Optional |
code | The error code. | string Optional |
details | The error details. | ErrorDetail_STATUS_Unrolled[] Optional |
message | The error message. | string Optional |
target | The error target. | string Optional |
FleetOperatorSecrets
Used by: FleetOperatorSpec.
Property | Description | Type |
---|---|---|
userCredentials | indicates where the UserCredentials secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
ManagedClusterUpgradeSpec
The upgrade to apply to a ManagedCluster.
Used by: ManagedClusterUpdate.
Property | Description | Type |
---|---|---|
kubernetesVersion | The Kubernetes version to upgrade the member clusters to. | string Optional |
type | ManagedClusterUpgradeType is the type of upgrade to be applied. | ManagedClusterUpgradeType Required |
ManagedClusterUpgradeSpec_STATUS
The upgrade to apply to a ManagedCluster.
Used by: ManagedClusterUpdate_STATUS.
Property | Description | Type |
---|---|---|
kubernetesVersion | The Kubernetes version to upgrade the member clusters to. | string Optional |
type | ManagedClusterUpgradeType is the type of upgrade to be applied. | ManagedClusterUpgradeType_STATUS Optional |
ManagedServiceIdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Used by: ManagedServiceIdentity.
Value | Description |
---|---|
“None” | |
“SystemAssigned” | |
“SystemAssigned, UserAssigned” | |
“UserAssigned” |
ManagedServiceIdentityType_STATUS
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Used by: ManagedServiceIdentity_STATUS.
Value | Description |
---|---|
“None” | |
“SystemAssigned” | |
“SystemAssigned, UserAssigned” | |
“UserAssigned” |
NodeImageSelection
The node image upgrade to be applied to the target nodes in update run.
Used by: ManagedClusterUpdate.
Property | Description | Type |
---|---|---|
type | The node image upgrade type. | NodeImageSelectionType Required |
NodeImageSelection_STATUS
The node image upgrade to be applied to the target nodes in update run.
Used by: ManagedClusterUpdate_STATUS.
Property | Description | Type |
---|---|---|
customNodeImageVersions | Custom node image versions to upgrade the nodes to. This field is required if node image selection type is Custom. Otherwise, it must be empty. For each node image family (e.g., ‘AKSUbuntu-1804gen2containerd’), this field can contain at most one version (e.g., only one of ‘AKSUbuntu-1804gen2containerd-2023.01.12’ or ‘AKSUbuntu-1804gen2containerd-2023.02.12’, not both). If the nodes belong to a family without a matching image version in this field, they are not upgraded. | NodeImageVersion_STATUS[] Optional |
type | The node image upgrade type. | NodeImageSelectionType_STATUS Optional |
NodeImageSelectionStatus_STATUS
The node image upgrade specs for the update run.
Used by: UpdateRunStatus_STATUS.
Property | Description | Type |
---|---|---|
selectedNodeImageVersions | The image versions to upgrade the nodes to. | NodeImageVersion_STATUS[] Optional |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
Value | Description |
---|---|
“Application” | |
“Key” | |
“ManagedIdentity” | |
“User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
Value | Description |
---|---|
“Application” | |
“Key” | |
“ManagedIdentity” | |
“User” |
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.
Used by: UpdateRunStrategy.
Property | Description | Type |
---|---|---|
afterStageWaitInSeconds | The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified. | int Optional |
groups | Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1. | UpdateGroup[] Optional |
name | The name of the stage. Must be unique within the UpdateRun. | string Required |
UpdateStage_STATUS
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.
Used by: UpdateRunStrategy_STATUS.
Property | Description | Type |
---|---|---|
afterStageWaitInSeconds | The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified. | int Optional |
groups | Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1. | UpdateGroup_STATUS[] Optional |
name | The name of the stage. Must be unique within the UpdateRun. | string Optional |
UpdateStageStatus_STATUS
The status of a UpdateStage.
Used by: UpdateRunStatus_STATUS.
Property | Description | Type |
---|---|---|
afterStageWaitStatus | The status of the wait period configured on the UpdateStage. | WaitStatus_STATUS Optional |
groups | The list of groups to be updated as part of this UpdateStage. | UpdateGroupStatus_STATUS[] Optional |
name | The name of the UpdateStage. | string Optional |
status | The status of the UpdateStage. | UpdateStatus_STATUS Optional |
UpdateStatus_STATUS
The status for an operation or group of operations.
Used by: MemberUpdateStatus_STATUS, UpdateGroupStatus_STATUS, UpdateRunStatus_STATUS, UpdateStageStatus_STATUS, and WaitStatus_STATUS.
Property | Description | Type |
---|---|---|
completedTime | The time the operation or group was completed. | string Optional |
error | The error details when a failure is encountered. | ErrorDetail_STATUS Optional |
startTime | The time the operation or group was started. | string Optional |
state | The State of the operation or group. | UpdateState_STATUS Optional |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: ManagedServiceIdentity.
Property | Description | Type |
---|---|---|
reference | genruntime.ResourceReference Optional |
ErrorAdditionalInfo_STATUS
The resource management error additional info.
Used by: ErrorDetail_STATUS, and ErrorDetail_STATUS_Unrolled.
Property | Description | Type |
---|---|---|
info | The additional info. | map[string]v1.JSON Optional |
type | The additional info type. | string Optional |
ErrorDetail_STATUS_Unrolled
Used by: ErrorDetail_STATUS.
Property | Description | Type |
---|---|---|
additionalInfo | The error additional info. | ErrorAdditionalInfo_STATUS[] Optional |
code | The error code. | string Optional |
message | The error message. | string Optional |
target | The error target. | string Optional |
ManagedClusterUpgradeType
The type of upgrade to perform when targeting ManagedClusters.
Used by: ManagedClusterUpgradeSpec.
Value | Description |
---|---|
“ControlPlaneOnly” | |
“Full” | |
“NodeImageOnly” |
ManagedClusterUpgradeType_STATUS
The type of upgrade to perform when targeting ManagedClusters.
Used by: ManagedClusterUpgradeSpec_STATUS.
Value | Description |
---|---|
“ControlPlaneOnly” | |
“Full” | |
“NodeImageOnly” |
NodeImageSelectionType
The node image upgrade type.
Used by: NodeImageSelection.
Value | Description |
---|---|
“Consistent” | |
“Custom” | |
“Latest” |
NodeImageSelectionType_STATUS
The node image upgrade type.
Used by: NodeImageSelection_STATUS.
Value | Description |
---|---|
“Consistent” | |
“Custom” | |
“Latest” |
NodeImageVersion_STATUS
The node upgrade image version.
Used by: NodeImageSelection_STATUS, and NodeImageSelectionStatus_STATUS.
Property | Description | Type |
---|---|---|
version | The image version to upgrade the nodes to (e.g., ‘AKSUbuntu-1804gen2containerd-2022.12.13’). | string Optional |
UpdateGroup
A group to be updated.
Used by: UpdateStage.
Property | Description | Type |
---|---|---|
name | Name of the group. It must match a group name of an existing fleet member. | string Required |
UpdateGroup_STATUS
A group to be updated.
Used by: UpdateStage_STATUS.
Property | Description | Type |
---|---|---|
name | Name of the group. It must match a group name of an existing fleet member. | string Optional |
UpdateGroupStatus_STATUS
The status of a UpdateGroup.
Used by: UpdateStageStatus_STATUS.
Property | Description | Type |
---|---|---|
members | The list of member this UpdateGroup updates. | MemberUpdateStatus_STATUS[] Optional |
name | The name of the UpdateGroup. | string Optional |
status | The status of the UpdateGroup. | UpdateStatus_STATUS Optional |
UpdateState_STATUS
The state of the UpdateRun, UpdateStage, UpdateGroup, or MemberUpdate.
Used by: UpdateStatus_STATUS.
Value | Description |
---|---|
“Completed” | |
“Failed” | |
“NotStarted” | |
“Pending” | |
“Running” | |
“Skipped” | |
“Stopped” | |
“Stopping” |
WaitStatus_STATUS
The status of the wait duration.
Used by: UpdateStageStatus_STATUS.
Property | Description | Type |
---|---|---|
status | The status of the wait duration. | UpdateStatus_STATUS Optional |
waitDurationInSeconds | The wait duration configured in seconds. | int Optional |
MemberUpdateStatus_STATUS
The status of a member update operation.
Used by: UpdateGroupStatus_STATUS.
Property | Description | Type |
---|---|---|
clusterResourceId | The Azure resource id of the target Kubernetes cluster. | string Optional |
message | The status message after processing the member update operation. | string Optional |
name | The name of the FleetMember. | string Optional |
operationId | The operation resource id of the latest attempt to perform the operation. | string Optional |
status | The status of the MemberUpdate operation. | UpdateStatus_STATUS Optional |