From 8ed680a19b098917868d0fef20fc5625cdb2b070 Mon Sep 17 00:00:00 2001 From: theunrepentantgeek Date: Sun, 1 Oct 2023 18:42:49 +0000 Subject: [PATCH] Update API Docs --- .../containerservice/v1api20230315preview.md | 4181 +++++++++++++++++ 1 file changed, 4181 insertions(+) create mode 100644 docs/hugo/content/reference/containerservice/v1api20230315preview.md diff --git a/docs/hugo/content/reference/containerservice/v1api20230315preview.md b/docs/hugo/content/reference/containerservice/v1api20230315preview.md new file mode 100644 index 00000000000..08c5c078ad3 --- /dev/null +++ b/docs/hugo/content/reference/containerservice/v1api20230315preview.md @@ -0,0 +1,4181 @@ +--- +title: containerservice.azure.com/v1api20230315preview +--- +

containerservice.azure.com/v1api20230315preview

+
+

Package v1api20230315preview contains API Schema definitions for the containerservice v1api20230315preview API group

+
+Resource Types: + +

APIVersion +(string alias)

+
+
+ + + + + + + + + + +
ValueDescription

"2023-03-15-preview"

+

ErrorAdditionalInfo_STATUS +

+

+(Appears on:ErrorDetail_STATUS, ErrorDetail_STATUS_Unrolled) +

+
+

The resource management error additional info.

+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+info
+ + +map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + + +		 +

Info: The additional info.

+
+type
+ +string + +		 +

Type: The additional info type.

+
+

ErrorAdditionalInfo_STATUS_ARM +

+

+(Appears on:ErrorDetail_STATUS_ARM, ErrorDetail_STATUS_Unrolled_ARM) +

+
+

The resource management error additional info.

+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+info
+ + +map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + + +		 +

Info: The additional info.

+
+type
+ +string + +		 +

Type: The additional info type.

+
+

ErrorDetail_STATUS +

+

+(Appears on:UpdateStatus_STATUS) +

+
+

The error detail.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+additionalInfo
+ + +[]ErrorAdditionalInfo_STATUS + + +		 +

AdditionalInfo: The error additional info.

+
+code
+ +string + +		 +

Code: The error code.

+
+details
+ + +[]ErrorDetail_STATUS_Unrolled + + +		 +

Details: The error details.

+
+message
+ +string + +		 +

Message: The error message.

+
+target
+ +string + +		 +

Target: The error target.

+
+

ErrorDetail_STATUS_ARM +

+

+(Appears on:UpdateStatus_STATUS_ARM) +

+
+

The error detail.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+additionalInfo
+ + +[]ErrorAdditionalInfo_STATUS_ARM + + +		 +

AdditionalInfo: The error additional info.

+
+code
+ +string + +		 +

Code: The error code.

+
+details
+ + +[]ErrorDetail_STATUS_Unrolled_ARM + + +		 +

Details: The error details.

+
+message
+ +string + +		 +

Message: The error message.

+
+target
+ +string + +		 +

Target: The error target.

+
+

ErrorDetail_STATUS_Unrolled +

+

+(Appears on:ErrorDetail_STATUS) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+additionalInfo
+ + +[]ErrorAdditionalInfo_STATUS + + +		 +

AdditionalInfo: The error additional info.

+
+code
+ +string + +		 +

Code: The error code.

+
+message
+ +string + +		 +

Message: The error message.

+
+target
+ +string + +		 +

Target: The error target.

+
+

ErrorDetail_STATUS_Unrolled_ARM +

+

+(Appears on:ErrorDetail_STATUS_ARM) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+additionalInfo
+ + +[]ErrorAdditionalInfo_STATUS_ARM + + +		 +

AdditionalInfo: The error additional info.

+
+code
+ +string + +		 +

Code: The error code.

+
+message
+ +string + +		 +

Message: The error message.

+
+target
+ +string + +		 +

Target: The error target.

+
+

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} +

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +Fleet_Spec + + +		 +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+azureName
+ +string + +		 +

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.

+
+hubProfile
+ + +FleetHubProfile + + +		 +

HubProfile: The FleetHubProfile configures the Fleet’s hub.

+
+location
+ +string + +		 +

Location: The geo-location where the resource lives

+
+operatorSpec
+ + +FleetOperatorSpec + + +		 +

OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure

+
+owner
+ + +genruntime.KnownResourceReference + + +		 +

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

+
+tags
+ +map[string]string + +		 +

Tags: Resource tags.

+
+
+status
+ + +Fleet_STATUS + + +		 +
+

FleetHubProfile +

+

+(Appears on:Fleet_Spec) +

+
+

The FleetHubProfile configures the fleet hub.

+
+ + + + + + + + + + + + + +
FieldDescription
+dnsPrefix
+ +string + +		 +

DnsPrefix: DNS prefix used to create the FQDN for the Fleet hub.

+
+

FleetHubProfile_ARM +

+

+(Appears on:FleetProperties_ARM) +

+
+

The FleetHubProfile configures the fleet hub.

+
+ + + + + + + + + + + + + +
FieldDescription
+dnsPrefix
+ +string + +		 +

DnsPrefix: DNS prefix used to create the FQDN for the Fleet hub.

+
+

FleetHubProfile_STATUS +

+

+(Appears on:Fleet_STATUS) +

+
+

The FleetHubProfile configures the fleet hub.

+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+dnsPrefix
+ +string + +		 +

DnsPrefix: DNS prefix used to create the FQDN for the Fleet hub.

+
+fqdn
+ +string + +		 +

Fqdn: The FQDN of the Fleet hub.

+
+kubernetesVersion
+ +string + +		 +

KubernetesVersion: The Kubernetes version of the Fleet hub.

+
+

FleetHubProfile_STATUS_ARM +

+

+(Appears on:FleetProperties_STATUS_ARM) +

+
+

The FleetHubProfile configures the fleet hub.

+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+dnsPrefix
+ +string + +		 +

DnsPrefix: DNS prefix used to create the FQDN for the Fleet hub.

+
+fqdn
+ +string + +		 +

Fqdn: The FQDN of the Fleet hub.

+
+kubernetesVersion
+ +string + +		 +

KubernetesVersion: The Kubernetes version of the Fleet hub.

+
+

FleetMemberProperties_ARM +

+

+(Appears on:Fleets_Member_Spec_ARM) +

+
+

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

+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+clusterResourceId
+ +string + +		 +
+group
+ +string + +		 +

Group: The group this member belongs to for multi-cluster update management.

+
+

FleetMemberProperties_STATUS_ARM +

+

+(Appears on:Fleets_Member_STATUS_ARM) +

+
+

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

+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+clusterResourceId
+ +string + +		 +

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}’. +

+group
+ +string + +		 +

Group: The group this member belongs to for multi-cluster update management.

+
+provisioningState
+ + +FleetMemberProvisioningState_STATUS + + +		 +

ProvisioningState: The status of the last operation.

+
+

FleetMemberProvisioningState_STATUS +(string alias)

+

+(Appears on:FleetMemberProperties_STATUS_ARM, Fleets_Member_STATUS) +

+
+

The provisioning state of the last accepted operation.

+
+ + + + + + + + + + + + + + + + + + + + +
ValueDescription

"Canceled"

"Failed"

"Joining"

"Leaving"

"Succeeded"

"Updating"

+

FleetOperatorSecrets +

+

+(Appears on:FleetOperatorSpec) +

+
+
+ + + + + + + + + + + + + +
FieldDescription
+userCredentials
+ + +genruntime.SecretDestination + + +		 +

UserCredentials: indicates where the UserCredentials secret should be placed. If omitted, the secret will not be +retrieved from Azure.

+
+

FleetOperatorSpec +

+

+(Appears on:Fleet_Spec) +

+
+

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

+
+ + + + + + + + + + + + + +
FieldDescription
+secrets
+ + +FleetOperatorSecrets + + +		 +

Secrets: configures where to place Azure generated secrets.

+
+

FleetProperties_ARM +

+

+(Appears on:Fleet_Spec_ARM) +

+
+

Fleet properties.

+
+ + + + + + + + + + + + + +
FieldDescription
+hubProfile
+ + +FleetHubProfile_ARM + + +		 +

HubProfile: The FleetHubProfile configures the Fleet’s hub.

+
+

FleetProperties_STATUS_ARM +

+

+(Appears on:Fleet_STATUS_ARM) +

+
+

Fleet properties.

+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+hubProfile
+ + +FleetHubProfile_STATUS_ARM + + +		 +

HubProfile: The FleetHubProfile configures the Fleet’s hub.

+
+provisioningState
+ + +FleetProvisioningState_STATUS + + +		 +

ProvisioningState: The status of the last operation.

+
+

FleetProvisioningState_STATUS +(string alias)

+

+(Appears on:FleetProperties_STATUS_ARM, Fleet_STATUS) +

+
+

The provisioning state of the last accepted operation.

+
+ + + + + + + + + + + + + + + + + + + + +
ValueDescription

"Canceled"

"Creating"

"Deleting"

"Failed"

"Succeeded"

"Updating"

+

Fleet_STATUS +

+

+(Appears on:Fleet) +

+
+

The Fleet resource.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+conditions
+ + +[]genruntime/conditions.Condition + + +		 +

Conditions: The observed state of the resource

+
+eTag
+ +string + +		 +

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.

+
+hubProfile
+ + +FleetHubProfile_STATUS + + +		 +

HubProfile: The FleetHubProfile configures the Fleet’s hub.

+
+id
+ +string + +		 +

Id: Fully qualified resource ID for the resource. Ex - +/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName} +

+location
+ +string + +		 +

Location: The geo-location where the resource lives

+
+name
+ +string + +		 +

Name: The name of the resource

+
+provisioningState
+ + +FleetProvisioningState_STATUS + + +		 +

ProvisioningState: The status of the last operation.

+
+systemData
+ + +SystemData_STATUS + + +		 +

SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.

+
+tags
+ +map[string]string + +		 +

Tags: Resource tags.

+
+type
+ +string + +		 +

Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

+
+

Fleet_STATUS_ARM +

+
+

The Fleet resource.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+eTag
+ +string + +		 +

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.

+
+id
+ +string + +		 +

Id: Fully qualified resource ID for the resource. Ex - +/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName} +

+location
+ +string + +		 +

Location: The geo-location where the resource lives

+
+name
+ +string + +		 +

Name: The name of the resource

+
+properties
+ + +FleetProperties_STATUS_ARM + + +		 +

Properties: The resource-specific properties for this resource.

+
+systemData
+ + +SystemData_STATUS_ARM + + +		 +

SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.

+
+tags
+ +map[string]string + +		 +

Tags: Resource tags.

+
+type
+ +string + +		 +

Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

+
+

Fleet_Spec +

+

+(Appears on:Fleet) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+azureName
+ +string + +		 +

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.

+
+hubProfile
+ + +FleetHubProfile + + +		 +

HubProfile: The FleetHubProfile configures the Fleet’s hub.

+
+location
+ +string + +		 +

Location: The geo-location where the resource lives

+
+operatorSpec
+ + +FleetOperatorSpec + + +		 +

OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure

+
+owner
+ + +genruntime.KnownResourceReference + + +		 +

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

+
+tags
+ +map[string]string + +		 +

Tags: Resource tags.

+
+

Fleet_Spec_ARM +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+location
+ +string + +		 +

Location: The geo-location where the resource lives

+
+name
+ +string + +		 +
+properties
+ + +FleetProperties_ARM + + +		 +

Properties: The resource-specific properties for this resource.

+
+tags
+ +map[string]string + +		 +

Tags: Resource tags.

+
+

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} +

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +Fleets_Member_Spec + + +		 +
+
+ + + + + + + + + + + + + + + + + +
+azureName
+ +string + +		 +

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.

+
+clusterResourceReference
+ + +genruntime.ResourceReference + + +		 +

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}’. +

+group
+ +string + +		 +

Group: The group this member belongs to for multi-cluster update management.

+
+owner
+ + +genruntime.KnownResourceReference + + +		 +

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

+
+
+status
+ + +Fleets_Member_STATUS + + +		 +
+

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} +

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +Fleets_UpdateRun_Spec + + +		 +
+
+ + + + + + + + + + + + + + + + + +
+azureName
+ +string + +		 +

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.

+
+managedClusterUpdate
+ + +ManagedClusterUpdate + + +		 +

ManagedClusterUpdate: The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be +modified until the run is started.

+
+owner
+ + +genruntime.KnownResourceReference + + +		 +

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

+
+strategy
+ + +UpdateRunStrategy + + +		 +

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.

+
+
+status
+ + +Fleets_UpdateRun_STATUS + + +		 +
+

Fleets_Member_STATUS +

+

+(Appears on:FleetsMember) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+clusterResourceId
+ +string + +		 +

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}’. +

+conditions
+ + +[]genruntime/conditions.Condition + + +		 +

Conditions: The observed state of the resource

+
+eTag
+ +string + +		 +

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.

+
+group
+ +string + +		 +

Group: The group this member belongs to for multi-cluster update management.

+
+id
+ +string + +		 +

Id: Fully qualified resource ID for the resource. Ex - +/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName} +

+name
+ +string + +		 +

Name: The name of the resource

+
+provisioningState
+ + +FleetMemberProvisioningState_STATUS + + +		 +

ProvisioningState: The status of the last operation.

+
+systemData
+ + +SystemData_STATUS + + +		 +

SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.

+
+type
+ +string + +		 +

Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

+
+

Fleets_Member_STATUS_ARM +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+eTag
+ +string + +		 +

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.

+
+id
+ +string + +		 +

Id: Fully qualified resource ID for the resource. Ex - +/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName} +

+name
+ +string + +		 +

Name: The name of the resource

+
+properties
+ + +FleetMemberProperties_STATUS_ARM + + +		 +

Properties: The resource-specific properties for this resource.

+
+systemData
+ + +SystemData_STATUS_ARM + + +		 +

SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.

+
+type
+ +string + +		 +

Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

+
+

Fleets_Member_Spec +

+

+(Appears on:FleetsMember) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+azureName
+ +string + +		 +

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.

+
+clusterResourceReference
+ + +genruntime.ResourceReference + + +		 +

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}’. +

+group
+ +string + +		 +

Group: The group this member belongs to for multi-cluster update management.

+
+owner
+ + +genruntime.KnownResourceReference + + +		 +

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

+
+

Fleets_Member_Spec_ARM +

+
+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+name
+ +string + +		 +
+properties
+ + +FleetMemberProperties_ARM + + +		 +

Properties: The resource-specific properties for this resource.

+
+

Fleets_UpdateRun_STATUS +

+

+(Appears on:FleetsUpdateRun) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+conditions
+ + +[]genruntime/conditions.Condition + + +		 +

Conditions: The observed state of the resource

+
+eTag
+ +string + +		 +

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.

+
+id
+ +string + +		 +

Id: Fully qualified resource ID for the resource. Ex - +/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName} +

+managedClusterUpdate
+ + +ManagedClusterUpdate_STATUS + + +		 +

ManagedClusterUpdate: The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be +modified until the run is started.

+
+name
+ +string + +		 +

Name: The name of the resource

+
+provisioningState
+ + +UpdateRunProvisioningState_STATUS + + +		 +

ProvisioningState: The provisioning state of the UpdateRun resource.

+
+status
+ + +UpdateRunStatus_STATUS + + +		 +

Status: The status of the UpdateRun.

+
+strategy
+ + +UpdateRunStrategy_STATUS + + +		 +

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.

+
+systemData
+ + +SystemData_STATUS + + +		 +

SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.

+
+type
+ +string + +		 +

Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

+
+

Fleets_UpdateRun_STATUS_ARM +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+eTag
+ +string + +		 +

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.

+
+id
+ +string + +		 +

Id: Fully qualified resource ID for the resource. Ex - +/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName} +

+name
+ +string + +		 +

Name: The name of the resource

+
+properties
+ + +UpdateRunProperties_STATUS_ARM + + +		 +

Properties: The resource-specific properties for this resource.

+
+systemData
+ + +SystemData_STATUS_ARM + + +		 +

SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.

+
+type
+ +string + +		 +

Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

+
+

Fleets_UpdateRun_Spec +

+

+(Appears on:FleetsUpdateRun) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+azureName
+ +string + +		 +

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.

+
+managedClusterUpdate
+ + +ManagedClusterUpdate + + +		 +

ManagedClusterUpdate: The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be +modified until the run is started.

+
+owner
+ + +genruntime.KnownResourceReference + + +		 +

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

+
+strategy
+ + +UpdateRunStrategy + + +		 +

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.

+
+

Fleets_UpdateRun_Spec_ARM +

+
+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+name
+ +string + +		 +
+properties
+ + +UpdateRunProperties_ARM + + +		 +

Properties: The resource-specific properties for this resource.

+
+

ManagedClusterUpdate +

+

+(Appears on:Fleets_UpdateRun_Spec) +

+
+

The update to be applied to the ManagedClusters.

+
+ + + + + + + + + + + + + +
FieldDescription
+upgrade
+ + +ManagedClusterUpgradeSpec + + +		 +

Upgrade: The upgrade to apply to the ManagedClusters.

+
+

ManagedClusterUpdate_ARM +

+

+(Appears on:UpdateRunProperties_ARM) +

+
+

The update to be applied to the ManagedClusters.

+
+ + + + + + + + + + + + + +
FieldDescription
+upgrade
+ + +ManagedClusterUpgradeSpec_ARM + + +		 +

Upgrade: The upgrade to apply to the ManagedClusters.

+
+

ManagedClusterUpdate_STATUS +

+

+(Appears on:Fleets_UpdateRun_STATUS) +

+
+

The update to be applied to the ManagedClusters.

+
+ + + + + + + + + + + + + +
FieldDescription
+upgrade
+ + +ManagedClusterUpgradeSpec_STATUS + + +		 +

Upgrade: The upgrade to apply to the ManagedClusters.

+
+

ManagedClusterUpdate_STATUS_ARM +

+

+(Appears on:UpdateRunProperties_STATUS_ARM) +

+
+

The update to be applied to the ManagedClusters.

+
+ + + + + + + + + + + + + +
FieldDescription
+upgrade
+ + +ManagedClusterUpgradeSpec_STATUS_ARM + + +		 +

Upgrade: The upgrade to apply to the ManagedClusters.

+
+

ManagedClusterUpgradeSpec +

+

+(Appears on:ManagedClusterUpdate) +

+
+

The upgrade to apply to a ManagedCluster.

+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+kubernetesVersion
+ +string + +		 +

KubernetesVersion: The Kubernetes version to upgrade the member clusters to.

+
+type
+ + +ManagedClusterUpgradeType + + +		 +

Type: The upgrade type. +Full requires the KubernetesVersion property to be set. +NodeImageOnly requires the KubernetesVersion property not to be set.

+
+

ManagedClusterUpgradeSpec_ARM +

+

+(Appears on:ManagedClusterUpdate_ARM) +

+
+

The upgrade to apply to a ManagedCluster.

+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+kubernetesVersion
+ +string + +		 +

KubernetesVersion: The Kubernetes version to upgrade the member clusters to.

+
+type
+ + +ManagedClusterUpgradeType + + +		 +

Type: The upgrade type. +Full requires the KubernetesVersion property to be set. +NodeImageOnly requires the KubernetesVersion property not to be set.

+
+

ManagedClusterUpgradeSpec_STATUS +

+

+(Appears on:ManagedClusterUpdate_STATUS) +

+
+

The upgrade to apply to a ManagedCluster.

+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+kubernetesVersion
+ +string + +		 +

KubernetesVersion: The Kubernetes version to upgrade the member clusters to.

+
+type
+ + +ManagedClusterUpgradeType_STATUS + + +		 +

Type: The upgrade type. +Full requires the KubernetesVersion property to be set. +NodeImageOnly requires the KubernetesVersion property not to be set.

+
+

ManagedClusterUpgradeSpec_STATUS_ARM +

+

+(Appears on:ManagedClusterUpdate_STATUS_ARM) +

+
+

The upgrade to apply to a ManagedCluster.

+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+kubernetesVersion
+ +string + +		 +

KubernetesVersion: The Kubernetes version to upgrade the member clusters to.

+
+type
+ + +ManagedClusterUpgradeType_STATUS + + +		 +

Type: The upgrade type. +Full requires the KubernetesVersion property to be set. +NodeImageOnly requires the KubernetesVersion property not to be set.

+
+

ManagedClusterUpgradeType +(string alias)

+

+(Appears on:ManagedClusterUpgradeSpec, ManagedClusterUpgradeSpec_ARM) +

+
+

The type of upgrade to perform when targeting ManagedClusters.

+
+ + + + + + + + + + + + +
ValueDescription

"Full"

"NodeImageOnly"

+

ManagedClusterUpgradeType_STATUS +(string alias)

+

+(Appears on:ManagedClusterUpgradeSpec_STATUS, ManagedClusterUpgradeSpec_STATUS_ARM) +

+
+

The type of upgrade to perform when targeting ManagedClusters.

+
+ + + + + + + + + + + + +
ValueDescription

"Full"

"NodeImageOnly"

+

MemberUpdateStatus_STATUS +

+

+(Appears on:UpdateGroupStatus_STATUS) +

+
+

The status of a member update operation.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+clusterResourceId
+ +string + +		 +

ClusterResourceId: The Azure resource id of the target Kubernetes cluster.

+
+name
+ +string + +		 +

Name: The name of the FleetMember.

+
+operationId
+ +string + +		 +

OperationId: The operation resource id of the latest attempt to perform the operation.

+
+status
+ + +UpdateStatus_STATUS + + +		 +

Status: The status of the MemberUpdate operation.

+
+

MemberUpdateStatus_STATUS_ARM +

+

+(Appears on:UpdateGroupStatus_STATUS_ARM) +

+
+

The status of a member update operation.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+clusterResourceId
+ +string + +		 +

ClusterResourceId: The Azure resource id of the target Kubernetes cluster.

+
+name
+ +string + +		 +

Name: The name of the FleetMember.

+
+operationId
+ +string + +		 +

OperationId: The operation resource id of the latest attempt to perform the operation.

+
+status
+ + +UpdateStatus_STATUS_ARM + + +		 +

Status: The status of the MemberUpdate operation.

+
+

SystemData_CreatedByType_STATUS +(string alias)

+

+(Appears on:SystemData_STATUS, SystemData_STATUS_ARM) +

+
+
+ + + + + + + + + + + + + + + + +
ValueDescription

"Application"

"Key"

"ManagedIdentity"

"User"

+

SystemData_LastModifiedByType_STATUS +(string alias)

+

+(Appears on:SystemData_STATUS, SystemData_STATUS_ARM) +

+
+
+ + + + + + + + + + + + + + + + +
ValueDescription

"Application"

"Key"

"ManagedIdentity"

"User"

+

SystemData_STATUS +

+

+(Appears on:Fleet_STATUS, Fleets_Member_STATUS, Fleets_UpdateRun_STATUS) +

+
+

Metadata pertaining to creation and last modification of the resource.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+createdAt
+ +string + +		 +

CreatedAt: The timestamp of resource creation (UTC).

+
+createdBy
+ +string + +		 +

CreatedBy: The identity that created the resource.

+
+createdByType
+ + +SystemData_CreatedByType_STATUS + + +		 +

CreatedByType: The type of identity that created the resource.

+
+lastModifiedAt
+ +string + +		 +

LastModifiedAt: The timestamp of resource last modification (UTC)

+
+lastModifiedBy
+ +string + +		 +

LastModifiedBy: The identity that last modified the resource.

+
+lastModifiedByType
+ + +SystemData_LastModifiedByType_STATUS + + +		 +

LastModifiedByType: The type of identity that last modified the resource.

+
+

SystemData_STATUS_ARM +

+

+(Appears on:Fleet_STATUS_ARM, Fleets_Member_STATUS_ARM, Fleets_UpdateRun_STATUS_ARM) +

+
+

Metadata pertaining to creation and last modification of the resource.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+createdAt
+ +string + +		 +

CreatedAt: The timestamp of resource creation (UTC).

+
+createdBy
+ +string + +		 +

CreatedBy: The identity that created the resource.

+
+createdByType
+ + +SystemData_CreatedByType_STATUS + + +		 +

CreatedByType: The type of identity that created the resource.

+
+lastModifiedAt
+ +string + +		 +

LastModifiedAt: The timestamp of resource last modification (UTC)

+
+lastModifiedBy
+ +string + +		 +

LastModifiedBy: The identity that last modified the resource.

+
+lastModifiedByType
+ + +SystemData_LastModifiedByType_STATUS + + +		 +

LastModifiedByType: The type of identity that last modified the resource.

+
+

UpdateGroup +

+

+(Appears on:UpdateStage) +

+
+

A group to be updated.

+
+ + + + + + + + + + + + + +
FieldDescription
+name
+ +string + +		 +

Name: The name of the Fleet member group to update. +It should match the name of an existing FleetMember group. +A group can only appear once across all UpdateStages in the UpdateRun.

+
+

UpdateGroupStatus_STATUS +

+

+(Appears on:UpdateStageStatus_STATUS) +

+
+

The status of a UpdateGroup.

+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+members
+ + +[]MemberUpdateStatus_STATUS + + +		 +

Members: The list of member this UpdateGroup updates.

+
+name
+ +string + +		 +

Name: The name of the UpdateGroup.

+
+status
+ + +UpdateStatus_STATUS + + +		 +

Status: The status of the UpdateGroup.

+
+

UpdateGroupStatus_STATUS_ARM +

+

+(Appears on:UpdateStageStatus_STATUS_ARM) +

+
+

The status of a UpdateGroup.

+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+members
+ + +[]MemberUpdateStatus_STATUS_ARM + + +		 +

Members: The list of member this UpdateGroup updates.

+
+name
+ +string + +		 +

Name: The name of the UpdateGroup.

+
+status
+ + +UpdateStatus_STATUS_ARM + + +		 +

Status: The status of the UpdateGroup.

+
+

UpdateGroup_ARM +

+

+(Appears on:UpdateStage_ARM) +

+
+

A group to be updated.

+
+ + + + + + + + + + + + + +
FieldDescription
+name
+ +string + +		 +

Name: The name of the Fleet member group to update. +It should match the name of an existing FleetMember group. +A group can only appear once across all UpdateStages in the UpdateRun.

+
+

UpdateGroup_STATUS +

+

+(Appears on:UpdateStage_STATUS) +

+
+

A group to be updated.

+
+ + + + + + + + + + + + + +
FieldDescription
+name
+ +string + +		 +

Name: The name of the Fleet member group to update. +It should match the name of an existing FleetMember group. +A group can only appear once across all UpdateStages in the UpdateRun.

+
+

UpdateGroup_STATUS_ARM +

+

+(Appears on:UpdateStage_STATUS_ARM) +

+
+

A group to be updated.

+
+ + + + + + + + + + + + + +
FieldDescription
+name
+ +string + +		 +

Name: The name of the Fleet member group to update. +It should match the name of an existing FleetMember group. +A group can only appear once across all UpdateStages in the UpdateRun.

+
+

UpdateRunProperties_ARM +

+

+(Appears on:Fleets_UpdateRun_Spec_ARM) +

+
+

The properties of the UpdateRun.

+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+managedClusterUpdate
+ + +ManagedClusterUpdate_ARM + + +		 +

ManagedClusterUpdate: The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be +modified until the run is started.

+
+strategy
+ + +UpdateRunStrategy_ARM + + +		 +

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.

+
+

UpdateRunProperties_STATUS_ARM +

+

+(Appears on:Fleets_UpdateRun_STATUS_ARM) +

+
+

The properties of the UpdateRun.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+managedClusterUpdate
+ + +ManagedClusterUpdate_STATUS_ARM + + +		 +

ManagedClusterUpdate: The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be +modified until the run is started.

+
+provisioningState
+ + +UpdateRunProvisioningState_STATUS + + +		 +

ProvisioningState: The provisioning state of the UpdateRun resource.

+
+status
+ + +UpdateRunStatus_STATUS_ARM + + +		 +

Status: The status of the UpdateRun.

+
+strategy
+ + +UpdateRunStrategy_STATUS_ARM + + +		 +

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.

+
+

UpdateRunProvisioningState_STATUS +(string alias)

+

+(Appears on:Fleets_UpdateRun_STATUS, UpdateRunProperties_STATUS_ARM) +

+
+

The provisioning state of the UpdateRun resource.

+
+ + + + + + + + + + + + + + +
ValueDescription

"Canceled"

"Failed"

"Succeeded"

+

UpdateRunStatus_STATUS +

+

+(Appears on:Fleets_UpdateRun_STATUS) +

+
+

The status of a UpdateRun.

+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+stages
+ + +[]UpdateStageStatus_STATUS + + +		 +

Stages: The stages composing an update run. Stages are run sequentially withing an UpdateRun.

+
+status
+ + +UpdateStatus_STATUS + + +		 +

Status: The status of the UpdateRun.

+
+

UpdateRunStatus_STATUS_ARM +

+

+(Appears on:UpdateRunProperties_STATUS_ARM) +

+
+

The status of a UpdateRun.

+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+stages
+ + +[]UpdateStageStatus_STATUS_ARM + + +		 +

Stages: The stages composing an update run. Stages are run sequentially withing an UpdateRun.

+
+status
+ + +UpdateStatus_STATUS_ARM + + +		 +

Status: The status of the UpdateRun.

+
+

UpdateRunStrategy +

+

+(Appears on:Fleets_UpdateRun_Spec) +

+
+

The UpdateRunStrategy configures the sequence of Stages and Groups in which the clusters will be updated.

+
+ + + + + + + + + + + + + +
FieldDescription
+stages
+ + +[]UpdateStage + + +		 +

Stages: The list of stages that compose this update run.

+
+

UpdateRunStrategy_ARM +

+

+(Appears on:UpdateRunProperties_ARM) +

+
+

The UpdateRunStrategy configures the sequence of Stages and Groups in which the clusters will be updated.

+
+ + + + + + + + + + + + + +
FieldDescription
+stages
+ + +[]UpdateStage_ARM + + +		 +

Stages: The list of stages that compose this update run.

+
+

UpdateRunStrategy_STATUS +

+

+(Appears on:Fleets_UpdateRun_STATUS) +

+
+

The UpdateRunStrategy configures the sequence of Stages and Groups in which the clusters will be updated.

+
+ + + + + + + + + + + + + +
FieldDescription
+stages
+ + +[]UpdateStage_STATUS + + +		 +

Stages: The list of stages that compose this update run.

+
+

UpdateRunStrategy_STATUS_ARM +

+

+(Appears on:UpdateRunProperties_STATUS_ARM) +

+
+

The UpdateRunStrategy configures the sequence of Stages and Groups in which the clusters will be updated.

+
+ + + + + + + + + + + + + +
FieldDescription
+stages
+ + +[]UpdateStage_STATUS_ARM + + +		 +

Stages: The list of stages that compose this update run.

+
+

UpdateStage +

+

+(Appears on:UpdateRunStrategy) +

+
+

Contains the groups to be updated by an UpdateRun. +Update order: +- Sequential between stages: Stages run sequentially. +The previous stage must complete before the next one starts. +- Parallel within a stage: Groups within a stage run in +parallel. +- Sequential within a group: Clusters within a group are updated sequentially.

+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+afterStageWaitInSeconds
+ +int + +		 +

AfterStageWaitInSeconds: The time in seconds to wait at the end of this stage before starting the next one. Defaults to +0 seconds if unspecified.

+
+groups
+ + +[]UpdateGroup + + +		 +

Groups: A list of group names that compose the stage. +The groups will be updated in parallel. Each group name can only appear once in the UpdateRun.

+
+name
+ +string + +		 +

Name: The name of the stage. Must be unique within the UpdateRun.

+
+

UpdateStageStatus_STATUS +

+

+(Appears on:UpdateRunStatus_STATUS) +

+
+

The status of a UpdateStage.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+afterStageWaitStatus
+ + +WaitStatus_STATUS + + +		 +

AfterStageWaitStatus: The status of the wait period configured on the UpdateStage.

+
+groups
+ + +[]UpdateGroupStatus_STATUS + + +		 +

Groups: The list of groups to be updated as part of this UpdateStage.

+
+name
+ +string + +		 +

Name: The name of the UpdateStage.

+
+status
+ + +UpdateStatus_STATUS + + +		 +

Status: The status of the UpdateStage.

+
+

UpdateStageStatus_STATUS_ARM +

+

+(Appears on:UpdateRunStatus_STATUS_ARM) +

+
+

The status of a UpdateStage.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+afterStageWaitStatus
+ + +WaitStatus_STATUS_ARM + + +		 +

AfterStageWaitStatus: The status of the wait period configured on the UpdateStage.

+
+groups
+ + +[]UpdateGroupStatus_STATUS_ARM + + +		 +

Groups: The list of groups to be updated as part of this UpdateStage.

+
+name
+ +string + +		 +

Name: The name of the UpdateStage.

+
+status
+ + +UpdateStatus_STATUS_ARM + + +		 +

Status: The status of the UpdateStage.

+
+

UpdateStage_ARM +

+

+(Appears on:UpdateRunStrategy_ARM) +

+
+

Contains the groups to be updated by an UpdateRun. +Update order: +- Sequential between stages: Stages run sequentially. +The previous stage must complete before the next one starts. +- Parallel within a stage: Groups within a stage run in +parallel. +- Sequential within a group: Clusters within a group are updated sequentially.

+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+afterStageWaitInSeconds
+ +int + +		 +

AfterStageWaitInSeconds: The time in seconds to wait at the end of this stage before starting the next one. Defaults to +0 seconds if unspecified.

+
+groups
+ + +[]UpdateGroup_ARM + + +		 +

Groups: A list of group names that compose the stage. +The groups will be updated in parallel. Each group name can only appear once in the UpdateRun.

+
+name
+ +string + +		 +

Name: The name of the stage. Must be unique within the UpdateRun.

+
+

UpdateStage_STATUS +

+

+(Appears on:UpdateRunStrategy_STATUS) +

+
+

Contains the groups to be updated by an UpdateRun. +Update order: +- Sequential between stages: Stages run sequentially. +The previous stage must complete before the next one starts. +- Parallel within a stage: Groups within a stage run in +parallel. +- Sequential within a group: Clusters within a group are updated sequentially.

+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+afterStageWaitInSeconds
+ +int + +		 +

AfterStageWaitInSeconds: The time in seconds to wait at the end of this stage before starting the next one. Defaults to +0 seconds if unspecified.

+
+groups
+ + +[]UpdateGroup_STATUS + + +		 +

Groups: A list of group names that compose the stage. +The groups will be updated in parallel. Each group name can only appear once in the UpdateRun.

+
+name
+ +string + +		 +

Name: The name of the stage. Must be unique within the UpdateRun.

+
+

UpdateStage_STATUS_ARM +

+

+(Appears on:UpdateRunStrategy_STATUS_ARM) +

+
+

Contains the groups to be updated by an UpdateRun. +Update order: +- Sequential between stages: Stages run sequentially. +The previous stage must complete before the next one starts. +- Parallel within a stage: Groups within a stage run in +parallel. +- Sequential within a group: Clusters within a group are updated sequentially.

+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+afterStageWaitInSeconds
+ +int + +		 +

AfterStageWaitInSeconds: The time in seconds to wait at the end of this stage before starting the next one. Defaults to +0 seconds if unspecified.

+
+groups
+ + +[]UpdateGroup_STATUS_ARM + + +		 +

Groups: A list of group names that compose the stage. +The groups will be updated in parallel. Each group name can only appear once in the UpdateRun.

+
+name
+ +string + +		 +

Name: The name of the stage. Must be unique within the UpdateRun.

+
+

UpdateState_STATUS +(string alias)

+

+(Appears on:UpdateStatus_STATUS, UpdateStatus_STATUS_ARM) +

+
+

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

+
+ + + + + + + + + + + + + + + + + + + + +
ValueDescription

"Completed"

"Failed"

"NotStarted"

"Running"

"Stopped"

"Stopping"

+

UpdateStatus_STATUS +

+

+(Appears on:MemberUpdateStatus_STATUS, UpdateGroupStatus_STATUS, UpdateRunStatus_STATUS, UpdateStageStatus_STATUS, WaitStatus_STATUS) +

+
+

The status for an operation or group of operations.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+completedTime
+ +string + +		 +

CompletedTime: The time the operation or group was completed.

+
+error
+ + +ErrorDetail_STATUS + + +		 +

Error: The error details when a failure is encountered.

+
+startTime
+ +string + +		 +

StartTime: The time the operation or group was started.

+
+state
+ + +UpdateState_STATUS + + +		 +

State: The State of the operation or group.

+
+

UpdateStatus_STATUS_ARM +

+

+(Appears on:MemberUpdateStatus_STATUS_ARM, UpdateGroupStatus_STATUS_ARM, UpdateRunStatus_STATUS_ARM, UpdateStageStatus_STATUS_ARM, WaitStatus_STATUS_ARM) +

+
+

The status for an operation or group of operations.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+completedTime
+ +string + +		 +

CompletedTime: The time the operation or group was completed.

+
+error
+ + +ErrorDetail_STATUS_ARM + + +		 +

Error: The error details when a failure is encountered.

+
+startTime
+ +string + +		 +

StartTime: The time the operation or group was started.

+
+state
+ + +UpdateState_STATUS + + +		 +

State: The State of the operation or group.

+
+

WaitStatus_STATUS +

+

+(Appears on:UpdateStageStatus_STATUS) +

+
+

The status of the wait duration.

+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+status
+ + +UpdateStatus_STATUS + + +		 +

Status: The status of the wait duration.

+
+waitDurationInSeconds
+ +int + +		 +

WaitDurationInSeconds: The wait duration configured in seconds.

+
+

WaitStatus_STATUS_ARM +

+

+(Appears on:UpdateStageStatus_STATUS_ARM) +

+
+

The status of the wait duration.

+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+status
+ + +UpdateStatus_STATUS_ARM + + +		 +

Status: The status of the wait duration.

+
+waitDurationInSeconds
+ +int + +		 +

WaitDurationInSeconds: The wait duration configured in seconds.

+
+