containerservice.azure.com/v1api20230315preview
APIVersion
| Value | Description |
|---|---|
| “2023-03-15-preview” |
Fleet
Generator information: - Generated from: /containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/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 |
| 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. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string 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 |
| 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/preview/2023-03-15-preview/fleets.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Fleet[] Optional |
FleetsMember
Generator information: - Generated from: /containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/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. Ex - /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 |
| 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/preview/2023-03-15-preview/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/preview/2023-03-15-preview/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 |
FleetsUpdateRun_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. Ex - /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 |
FleetsUpdateRunList
Generator information: - Generated from: /containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/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 |
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 |
| 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. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string 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 |
| 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 |
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. Ex - /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 |
| 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 |
FleetsUpdateRun_STATUS
Used by: FleetsUpdateRun.
| 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. Ex - /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 |
FleetHubProfile
The FleetHubProfile configures the fleet hub.
Used by: Fleet_Spec.
| Property | Description | Type |
|---|---|---|
| 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 |
|---|---|---|
| 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 |
FleetMemberProvisioningState_STATUS
The provisioning state of the last accepted operation.
Used by: FleetsMember_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Failed” | |
| “Joining” | |
| “Leaving” | |
| “Succeeded” | |
| “Updating” |
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” |
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 |
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 |
ManagedClusterUpdate
The update to be applied to the ManagedClusters.
Used by: FleetsUpdateRun_Spec.
| Property | Description | Type |
|---|---|---|
| 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 |
|---|---|---|
| upgrade | The upgrade to apply to the ManagedClusters. | ManagedClusterUpgradeSpec_STATUS Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: Fleet_STATUS, FleetsMember_STATUS, and FleetsUpdateRun_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 |
|---|---|---|
| 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.
| 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.
| Property | Description | Type |
|---|---|---|
| stages | The list of stages that compose this update run. Min size: 1. | UpdateStage_STATUS[] 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 |
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 |
ErrorDetail_STATUS
The error detail.
Used by: 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 |
ManagedClusterUpgradeType
The type of upgrade to perform when targeting ManagedClusters.
Used by: ManagedClusterUpgradeSpec.
| Value | Description |
|---|---|
| “Full” | |
| “NodeImageOnly” |
ManagedClusterUpgradeType_STATUS
The type of upgrade to perform when targeting ManagedClusters.
Used by: ManagedClusterUpgradeSpec_STATUS.
| Value | Description |
|---|---|
| “Full” | |
| “NodeImageOnly” |
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” | |
| “Running” | |
| “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 |
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 |
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 |
| 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 |