Microsoft.ContainerService (preview:2025-04-01)

2025/12/05 • 6 updated methods

Fleets_ListBySubscription (updated)
Description :  Lists fleets in the specified subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Fleets_ListBySubscription",
  "$parameters": {
    "@added_7f19875408a544c3a81d06d43d8d0c08": {
      "#name": "$top",
      "Description": "The number of result items to return.",
      "Format": "int32",
      "Required": false,
      "Type": "integer"
    },
    "@added_a70058a597ab4320b403b941d1c2d6b8": {
      "#name": "$skipToken",
      "Description": "The page-continuation token to use with a paged version of this API.",
      "Required": false,
      "Type": "string"
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/fleets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Fleet items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
hubProfile:
{
Description: The FleetHubProfile configures the Fleet's hub. ,
Required: False ,
}
{
dnsPrefix:
{
Description: DNS prefix used to create the FQDN for the Fleet hub. ,
Required: False ,
}
string ,
apiServerAccessProfile:
{
Description: The access profile for the Fleet hub API server. ,
Required: False ,
}
{
enablePrivateCluster:
{
Description: Whether to create the Fleet hub as a private cluster or not. ,
Required: False ,
}
boolean ,
enableVnetIntegration:
{
Description: Whether to enable apiserver vnet integration for the Fleet hub or not. ,
Required: False ,
}
boolean ,
subnetId:
{
Description: The subnet to be used when apiserver vnet integration is enabled. It is required when creating a new Fleet with BYO vnet. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
agentProfile:
{
Description: The agent profile for the Fleet hub. ,
Required: False ,
}
{
subnetId:
{
Description: 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. ,
Format: arm-id ,
Required: False ,
}
string ,
vmSize:
{
Description: The virtual machine size of the Fleet hub. ,
Required: False ,
}
string ,
}
,
fqdn:
{
Description: The FQDN of the Fleet hub. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The Kubernetes version of the Fleet hub. ,
Required: False ,
}
string ,
portalFqdn:
{
Description: The Azure Portal FQDN of the Fleet hub. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Status information for the fleet. ,
Required: False ,
}
{
lastOperationId:
{
Description: The last operation ID for the fleet. ,
Required: False ,
}
string ,
lastOperationError:
{
Description: The last operation error for the fleet. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
eTag:
{
Description: 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. ,
Required: False ,
}
string ,
identity:
{
Description: Managed identity. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutoUpgradeProfiles_ListByFleet (updated)
Description :  List AutoUpgradeProfile resources by Fleet
Reference :  Link ¶

⚶ Changes

{
  "#id": "AutoUpgradeProfiles_ListByFleet",
  "$parameters": {
    "@added_761f7bdc5b114f3586ca4d158c190056": {
      "#name": "$top",
      "Description": "The number of result items to return.",
      "Format": "int32",
      "Required": false,
      "Type": "integer"
    },
    "@added_2ce44a151b3841a285837c3d8a68f75c": {
      "#name": "$skipToken",
      "Description": "The page-continuation token to use with a paged version of this API.",
      "Required": false,
      "Type": "string"
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/autoUpgradeProfiles
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: The name of the Fleet resource. ,
Required: True ,
}
string ,
$top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AutoUpgradeProfile items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the AutoUpgradeProfile resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
updateStrategyId:
{
Description: 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. ,
Format: arm-id ,
Required: False ,
}
string ,
channel:
{
Description: Configures how auto-upgrade will be run. ,
Enum:
{
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 ,
}
,
Required: True ,
}
enum ,
nodeImageSelection:
{
Description: The node image upgrade to be applied to the target clusters in auto upgrade. ,
Required: False ,
}
{
type:
{
Description: The node image upgrade type. ,
Enum:
{
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'. ,
}
,
Required: True ,
}
enum ,
}
,
disabled:
{
Description: 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. ,
Required: False ,
}
boolean ,
autoUpgradeProfileStatus:
{
Description: The status of the auto upgrade profile. ,
Required: False ,
}
{
lastTriggeredAt:
{
Description: The UTC time of the last attempt to automatically create and start an UpdateRun as triggered by the release of new versions. ,
Format: date-time ,
Required: False ,
}
string ,
lastTriggerStatus:
{
Description: The status of the last AutoUpgrade trigger. ,
Enum:
{
Succeeded: The last AutoUpgrade trigger was succeeded. ,
Failed: The last AutoUpgrade trigger failed. ,
}
,
Required: False ,
}
enum ,
lastTriggerError:
{
Description: The error details of the last trigger. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
lastTriggerUpgradeVersions:
{
Description: The target Kubernetes version or node image versions of the last trigger. ,
Required: False ,
}
[
string ,
]
,
}
,
targetKubernetesVersion:
{
Description: This is the target Kubernetes version for auto-upgrade. The format must be `{major version}.{minor version}`. For example, "1.30". By default, this is empty. If upgrade channel is set to TargetKubernetesVersion, this field must not be empty. If upgrade channel is Rapid, Stable or NodeImage, this field must be empty. ,
Required: False ,
}
string ,
longTermSupport:
{
Description: If upgrade channel is not TargetKubernetesVersion, this field must be False. If set to True: Fleet auto upgrade will continue generate update runs for patches of minor versions earlier than N-2 (where N is the latest supported minor version) if those minor versions support Long-Term Support (LTS). By default, this is set to False. For more information on AKS LTS, please see https://learn.microsoft.com/en-us/azure/aks/long-term-support ,
Required: False ,
}
boolean ,
}
,
eTag:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gates_ListByFleet (updated)
Description :  List Gate resources by Fleet
Reference :  Link ¶

⚶ Changes

{
  "#id": "Gates_ListByFleet",
  "$parameters": {
    "@added_9ba4b0cf56e94b2cbb480ec7eec921d9": {
      "#name": "$filter",
      "Description": "Filter the result list using the given expression.",
      "Required": false,
      "Type": "string"
    },
    "@added_c5b59f4d043b49408bfe043801838843": {
      "#name": "$top",
      "Description": "The number of result items to return.",
      "Format": "int32",
      "Required": false,
      "Type": "integer"
    },
    "@added_1053be664e374563bd6061583c65c93f": {
      "#name": "$skipToken",
      "Description": "The page-continuation token to use with a paged version of this API.",
      "Required": false,
      "Type": "string"
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/gates
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: The name of the Fleet resource. ,
Required: True ,
}
string ,
$filter:
{
Description: Filter the result list using the given expression. ,
Required: False ,
}
string ,
$top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Gate items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the Gate resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The human-readable display name of the Gate. ,
Required: False ,
}
string ,
gateType:
{
Description: The type of the Gate determines how it is completed. ,
Enum:
{
Approval: An approval gate is completed by setting its state to be Completed. ,
}
,
Required: True ,
}
enum ,
target:
{
Description: The target that the Gate is controlling, e.g. an Update Run. ,
Required: True ,
}
{
id:
{
Description: The resource id that the Gate is controlling the rollout of. ,
Format: arm-id ,
Required: True ,
}
string ,
updateRunProperties:
{
Description: The properties of the Update Run that the Gate is targeting. ,
Required: False ,
}
{
name:
{
Description: The name of the Update Run. ,
Required: True ,
}
string ,
stage:
{
Description: The Update Stage of the Update Run. ,
Required: False ,
}
string ,
group:
{
Description: The Update Group of the Update Run. ,
Required: False ,
}
string ,
timing:
{
Description: Whether the Gate is placed before or after the update itself. ,
Enum:
{
Before: The Gate is before the target. ,
After: The Gate is after the target. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
state:
{
Description: The state of the Gate. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
}
,
eTag:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FleetMembers_ListByFleet (updated)
Description :  List FleetMember resources by Fleet
Reference :  Link ¶

⚶ Changes

{
  "#id": "FleetMembers_ListByFleet",
  "$parameters": {
    "@added_4724ceea63a8477db8239192bafc8df9": {
      "#name": "$top",
      "Description": "The number of result items to return.",
      "Format": "int32",
      "Required": false,
      "Type": "integer"
    },
    "@added_013f6e1ae33f41bf8396439bc322f076": {
      "#name": "$skipToken",
      "Description": "The page-continuation token to use with a paged version of this API.",
      "Required": false,
      "Type": "string"
    },
    "@added_5ac6995d74994d3895d2ca9f468897ac": {
      "#name": "$filter",
      "Description": "Filter the result list using the given expression.",
      "Required": false,
      "Type": "string"
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/members
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: The name of the Fleet resource. ,
Required: True ,
}
string ,
$top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
$filter:
{
Description: Filter the result list using the given expression. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The FleetMember items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
clusterResourceId:
{
Description: 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}'. ,
Format: arm-id ,
Required: True ,
}
string ,
group:
{
Description: The group this member belongs to for multi-cluster update management. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
labels:
{
Description: The labels for the fleet member. ,
Required: False ,
}
object ,
status:
{
Description: Status information of the last operation for fleet member. ,
Required: False ,
}
{
lastOperationId:
{
Description: The last operation ID for the fleet member ,
Required: False ,
}
string ,
lastOperationError:
{
Description: The last operation error of the fleet member ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
eTag:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateRuns_ListByFleet (updated)
Description :  List UpdateRun resources by Fleet
Reference :  Link ¶

⚶ Changes

{
  "#id": "UpdateRuns_ListByFleet",
  "$parameters": {
    "@added_f376e38445f145689ea2ef1542c6a165": {
      "#name": "$top",
      "Description": "The number of result items to return.",
      "Format": "int32",
      "Required": false,
      "Type": "integer"
    },
    "@added_7019d2f4c0e94088bb0446dbab70cea0": {
      "#name": "$skipToken",
      "Description": "The page-continuation token to use with a paged version of this API.",
      "Required": false,
      "Type": "string"
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateRuns
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: The name of the Fleet resource. ,
Required: True ,
}
string ,
$top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The UpdateRun items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the UpdateRun resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
updateStrategyId:
{
Description: 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. ,
Format: arm-id ,
Required: False ,
}
string ,
strategy:
{
Description: 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. ,
Required: False ,
}
{
stages:
{
Description: The list of stages that compose this update run. Min size: 1. ,
Required: True ,
}
[
{
name:
{
Description: The name of the stage. Must be unique within the UpdateRun. ,
Required: True ,
}
string ,
groups:
{
Description: Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1. ,
Required: False ,
}
[
{
name:
{
Description: Name of the group. It must match a group name of an existing fleet member. ,
Required: True ,
}
string ,
beforeGates:
{
Description: A list of Gates that will be created before this Group is executed. ,
Required: False ,
}
[
{
displayName:
{
Description: The human-readable display name of the Gate. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Gate determines how it is completed. ,
Enum:
{
Approval: An approval gate is completed by setting its state to be Completed. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
afterGates:
{
Description: A list of Gates that will be created after this Group is executed. ,
Required: False ,
}
[
{
displayName:
{
Description: The human-readable display name of the Gate. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Gate determines how it is completed. ,
Enum:
{
Approval: An approval gate is completed by setting its state to be Completed. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
afterStageWaitInSeconds:
{
Description: The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified. ,
Format: int32 ,
Required: False ,
}
integer ,
beforeGates:
{
Description: A list of Gates that will be created before this Stage is executed. ,
Required: False ,
}
[
{
displayName:
{
Description: The human-readable display name of the Gate. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Gate determines how it is completed. ,
Enum:
{
Approval: An approval gate is completed by setting its state to be Completed. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
afterGates:
{
Description: A list of Gates that will be created after this Stage is executed. ,
Required: False ,
}
[
{
displayName:
{
Description: The human-readable display name of the Gate. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Gate determines how it is completed. ,
Enum:
{
Approval: An approval gate is completed by setting its state to be Completed. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
managedClusterUpdate:
{
Description: The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started. ,
Required: True ,
}
{
upgrade:
{
Description: The upgrade to apply to the ManagedClusters. ,
Required: True ,
}
{
type:
{
Description: ManagedClusterUpgradeType is the type of upgrade to be applied. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
kubernetesVersion:
{
Description: The Kubernetes version to upgrade the member clusters to. ,
Required: False ,
}
string ,
}
,
nodeImageSelection:
{
Description: The node image upgrade to be applied to the target nodes in update run. ,
Required: False ,
}
{
type:
{
Description: The node image upgrade type. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
customNodeImageVersions:
{
Description: 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. ,
Required: False ,
}
[
{
version:
{
Description: The image version to upgrade the nodes to (e.g., 'AKSUbuntu-1804gen2containerd-2022.12.13'). ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
status:
{
Description: The status of the UpdateRun. ,
Required: False ,
}
{
status:
{
Description: The status of the UpdateRun. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
stages:
{
Description: The stages composing an update run. Stages are run sequentially withing an UpdateRun. ,
Required: False ,
}
[
{
status:
{
Description: The status of the UpdateStage. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the UpdateStage. ,
Required: False ,
}
string ,
groups:
{
Description: The list of groups to be updated as part of this UpdateStage. ,
Required: False ,
}
[
{
status:
{
Description: The status of the UpdateGroup. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the UpdateGroup. ,
Required: False ,
}
string ,
members:
{
Description: The list of member this UpdateGroup updates. ,
Required: False ,
}
[
{
status:
{
Description: The status of the MemberUpdate operation. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the FleetMember. ,
Required: False ,
}
string ,
clusterResourceId:
{
Description: The Azure resource id of the target Kubernetes cluster. ,
Required: False ,
}
string ,
operationId:
{
Description: The operation resource id of the latest attempt to perform the operation. ,
Required: False ,
}
string ,
message:
{
Description: The status message after processing the member update operation. ,
Required: False ,
}
string ,
}
,
]
,
beforeGates:
{
Description: The list of Gates that will run before this UpdateGroup. ,
Required: False ,
}
[
{
displayName:
{
Description: The human-readable display name of the Gate. ,
Required: False ,
}
string ,
gateId:
{
Description: The resource id of the Gate. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The status of the Gate. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
]
,
afterGates:
{
Description: The list of Gates that will run after this UpdateGroup. ,
Required: False ,
}
[
{
displayName:
{
Description: The human-readable display name of the Gate. ,
Required: False ,
}
string ,
gateId:
{
Description: The resource id of the Gate. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The status of the Gate. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
]
,
}
,
]
,
beforeGates:
{
Description: The list of Gates that will run before this UpdateStage. ,
Required: False ,
}
[
{
displayName:
{
Description: The human-readable display name of the Gate. ,
Required: False ,
}
string ,
gateId:
{
Description: The resource id of the Gate. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The status of the Gate. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
]
,
afterGates:
{
Description: The list of Gates that will run after this UpdateStage. ,
Required: False ,
}
[
{
displayName:
{
Description: The human-readable display name of the Gate. ,
Required: False ,
}
string ,
gateId:
{
Description: The resource id of the Gate. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The status of the Gate. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
]
,
afterStageWaitStatus:
{
Description: The status of the wait period configured on the UpdateStage. ,
Required: False ,
}
{
status:
{
Description: The status of the wait duration. ,
Required: False ,
}
{
startTime:
{
Description: The time the operation or group was started. ,
Format: date-time ,
Required: False ,
}
string ,
completedTime:
{
Description: The time the operation or group was completed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The State of the operation or group. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error details when a failure is encountered. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
waitDurationInSeconds:
{
Description: The wait duration configured in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nodeImageSelection:
{
Description: The node image upgrade specs for the update run. It is only set in update run when `NodeImageSelection.type` is `Consistent`. ,
Required: False ,
}
{
selectedNodeImageVersions:
{
Description: The image versions to upgrade the nodes to. ,
Required: False ,
}
[
{
version:
{
Description: The image version to upgrade the nodes to (e.g., 'AKSUbuntu-1804gen2containerd-2022.12.13'). ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
autoUpgradeProfileId:
{
Description: AutoUpgradeProfileId is the id of an auto upgrade profile resource. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FleetUpdateStrategies_ListByFleet (updated)
Description :  List FleetUpdateStrategy resources by Fleet
Reference :  Link ¶

⚶ Changes

{
  "#id": "FleetUpdateStrategies_ListByFleet",
  "$parameters": {
    "@added_1113dc7efd944952a7cc76cd25d5b9b8": {
      "#name": "$top",
      "Description": "The number of result items to return.",
      "Format": "int32",
      "Required": false,
      "Type": "integer"
    },
    "@added_e364b84ec3d44debadf56a79b40110c1": {
      "#name": "$skipToken",
      "Description": "The page-continuation token to use with a paged version of this API.",
      "Required": false,
      "Type": "string"
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateStrategies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: The name of the Fleet resource. ,
Required: True ,
}
string ,
$top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The FleetUpdateStrategy items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the UpdateStrategy resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
strategy:
{
Description: Defines the update sequence of the clusters. ,
Required: True ,
}
{
stages:
{
Description: The list of stages that compose this update run. Min size: 1. ,
Required: True ,
}
[
{
name:
{
Description: The name of the stage. Must be unique within the UpdateRun. ,
Required: True ,
}
string ,
groups:
{
Description: Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1. ,
Required: False ,
}
[
{
name:
{
Description: Name of the group. It must match a group name of an existing fleet member. ,
Required: True ,
}
string ,
beforeGates:
{
Description: A list of Gates that will be created before this Group is executed. ,
Required: False ,
}
[
{
displayName:
{
Description: The human-readable display name of the Gate. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Gate determines how it is completed. ,
Enum:
{
Approval: An approval gate is completed by setting its state to be Completed. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
afterGates:
{
Description: A list of Gates that will be created after this Group is executed. ,
Required: False ,
}
[
{
displayName:
{
Description: The human-readable display name of the Gate. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Gate determines how it is completed. ,
Enum:
{
Approval: An approval gate is completed by setting its state to be Completed. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
afterStageWaitInSeconds:
{
Description: The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified. ,
Format: int32 ,
Required: False ,
}
integer ,
beforeGates:
{
Description: A list of Gates that will be created before this Stage is executed. ,
Required: False ,
}
[
{
displayName:
{
Description: The human-readable display name of the Gate. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Gate determines how it is completed. ,
Enum:
{
Approval: An approval gate is completed by setting its state to be Completed. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
afterGates:
{
Description: A list of Gates that will be created after this Stage is executed. ,
Required: False ,
}
[
{
displayName:
{
Description: The human-readable display name of the Gate. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Gate determines how it is completed. ,
Enum:
{
Approval: An approval gate is completed by setting its state to be Completed. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
}
,
eTag:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}