Microsoft.ContainerService (preview:2023-03-15)

2025/12/05 • 3 updated methods

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

⚶ Changes

{
  "#id": "Fleets_ListBySubscription",
  "$parameters": {
    "@added_71227a647a83479a875bd0451e736958": {
      "#name": "$top",
      "Description": "The number of result items to return.",
      "Format": "int32",
      "Required": false,
      "Type": "integer"
    },
    "@added_9c12864dbf0f4b88827d639bb6b90c70": {
      "#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. ,
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 ,
fqdn:
{
Description: The FQDN of the Fleet hub. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The Kubernetes version of the Fleet hub. ,
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 ,
}
,
]
,
}
,
}
FleetMembers_ListByFleet (updated)
Description :  List FleetMember resources by Fleet
Reference :  Link ¶

⚶ Changes

{
  "#id": "FleetMembers_ListByFleet",
  "$parameters": {
    "@added_f8e3fcea0c104014b83a0d9fb23029f3": {
      "#name": "$top",
      "Description": "The number of result items to return.",
      "Format": "int32",
      "Required": false,
      "Type": "integer"
    },
    "@added_1049330d496c459ca5c0f7f213f1a3d8": {
      "#name": "$skipToken",
      "Description": "The page-continuation token to use with a paged version of this API.",
      "Required": false,
      "Type": "string"
    },
    "@added_19b9c5af2c3b4c448866ca0e32c00fd5": {
      "#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. ,
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 ,
}
,
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_0e7a0f6e9b1d435d88364cd919ad0851": {
      "#name": "$top",
      "Description": "The number of result items to return.",
      "Format": "int32",
      "Required": false,
      "Type": "integer"
    },
    "@added_9f3522cd9d0e4a4fa693794cb4c3837a": {
      "#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. ,
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 ,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
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. ,
}
,
Required: True ,
}
enum ,
kubernetesVersion:
{
Description: The Kubernetes version to upgrade the member clusters to. ,
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. ,
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. ,
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. ,
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. ,
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 ,
}
,
]
,
}
,
]
,
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. ,
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 ,
}
,
}
,
]
,
}
,
}
,
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 ,
}
,
]
,
}
,
}