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)

    Value Description

    "2023-03-15-preview"

    ErrorAdditionalInfo_STATUS

    (Appears on:ErrorDetail_STATUS, ErrorDetail_STATUS_Unrolled)

    The resource management error additional info.

    Field Description
    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.

    Field Description
    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.

    Field Description
    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.

    Field Description
    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)

    Field Description
    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)

    Field Description
    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}

    Field Description
    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.

    Field Description
    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.

    Field Description
    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.

    Field Description
    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.

    Field Description
    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.

    Field Description
    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.

    Field Description
    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.

    Value Description

    "Canceled"

    "Failed"

    "Joining"

    "Leaving"

    "Succeeded"

    "Updating"

    FleetOperatorSecrets

    (Appears on:FleetOperatorSpec)

    Field Description
    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

    Field Description
    secrets
    FleetOperatorSecrets

    Secrets: configures where to place Azure generated secrets.

    FleetProperties_ARM

    (Appears on:Fleet_Spec_ARM)

    Fleet properties.

    Field Description
    hubProfile
    FleetHubProfile_ARM

    HubProfile: The FleetHubProfile configures the Fleet’s hub.

    FleetProperties_STATUS_ARM

    (Appears on:Fleet_STATUS_ARM)

    Fleet properties.

    Field Description
    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.

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    Fleet_STATUS

    (Appears on:Fleet)

    The Fleet resource.

    Field Description
    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.

    Field Description
    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)

    Field Description
    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

    Field Description
    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}

    Field Description
    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}

    Field Description
    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)

    Field Description
    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

    Field Description
    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)

    Field Description
    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

    Field Description
    name
    string
    properties
    FleetMemberProperties_ARM

    Properties: The resource-specific properties for this resource.

    Fleets_UpdateRun_STATUS

    (Appears on:FleetsUpdateRun)

    Field Description
    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

    Field Description
    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)

    Field Description
    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

    Field Description
    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.

    Field Description
    upgrade
    ManagedClusterUpgradeSpec

    Upgrade: The upgrade to apply to the ManagedClusters.

    ManagedClusterUpdate_ARM

    (Appears on:UpdateRunProperties_ARM)

    The update to be applied to the ManagedClusters.

    Field Description
    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.

    Field Description
    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.

    Field Description
    upgrade
    ManagedClusterUpgradeSpec_STATUS_ARM

    Upgrade: The upgrade to apply to the ManagedClusters.

    ManagedClusterUpgradeSpec

    (Appears on:ManagedClusterUpdate)

    The upgrade to apply to a ManagedCluster.

    Field Description
    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.

    Field Description
    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.

    Field Description
    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.

    Field Description
    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.

    Value Description

    "Full"

    "NodeImageOnly"

    ManagedClusterUpgradeType_STATUS (string alias)

    (Appears on:ManagedClusterUpgradeSpec_STATUS, ManagedClusterUpgradeSpec_STATUS_ARM)

    The type of upgrade to perform when targeting ManagedClusters.

    Value Description

    "Full"

    "NodeImageOnly"

    MemberUpdateStatus_STATUS

    (Appears on:UpdateGroupStatus_STATUS)

    The status of a member update operation.

    Field Description
    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.

    Field Description
    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)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS, SystemData_STATUS_ARM)

    Value Description

    "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.

    Field Description
    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.

    Field Description
    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.

    Field Description
    name
    string

    Name: Name of the group. It must match a group name of an existing fleet member.

    UpdateGroupStatus_STATUS

    (Appears on:UpdateStageStatus_STATUS)

    The status of a UpdateGroup.

    Field Description
    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.

    Field Description
    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.

    Field Description
    name
    string

    Name: Name of the group. It must match a group name of an existing fleet member.

    UpdateGroup_STATUS

    (Appears on:UpdateStage_STATUS)

    A group to be updated.

    Field Description
    name
    string

    Name: Name of the group. It must match a group name of an existing fleet member.

    UpdateGroup_STATUS_ARM

    (Appears on:UpdateStage_STATUS_ARM)

    A group to be updated.

    Field Description
    name
    string

    Name: Name of the group. It must match a group name of an existing fleet member.

    UpdateRunProperties_ARM

    (Appears on:Fleets_UpdateRun_Spec_ARM)

    The properties of the UpdateRun.

    Field Description
    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.

    Field Description
    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.

    Value Description

    "Canceled"

    "Failed"

    "Succeeded"

    UpdateRunStatus_STATUS

    (Appears on:Fleets_UpdateRun_STATUS)

    The status of a UpdateRun.

    Field Description
    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.

    Field Description
    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)

    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.

    Field Description
    stages
    []UpdateStage

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

    UpdateRunStrategy_ARM

    (Appears on:UpdateRunProperties_ARM)

    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.

    Field Description
    stages
    []UpdateStage_ARM

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

    UpdateRunStrategy_STATUS

    (Appears on:Fleets_UpdateRun_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.

    Field Description
    stages
    []UpdateStage_STATUS

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

    UpdateRunStrategy_STATUS_ARM

    (Appears on:UpdateRunProperties_STATUS_ARM)

    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.

    Field Description
    stages
    []UpdateStage_STATUS_ARM

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

    UpdateStage

    (Appears on:UpdateRunStrategy)

    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.

    Field Description
    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: Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1.

    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.

    Field Description
    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.

    Field Description
    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)

    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.

    Field Description
    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: Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1.

    name
    string

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

    UpdateStage_STATUS

    (Appears on:UpdateRunStrategy_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.

    Field Description
    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: Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1.

    name
    string

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

    UpdateStage_STATUS_ARM

    (Appears on:UpdateRunStrategy_STATUS_ARM)

    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.

    Field Description
    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: Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1.

    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.

    Value Description

    "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.

    Field Description
    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.

    Field Description
    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.

    Field Description
    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.

    Field Description
    status
    UpdateStatus_STATUS_ARM

    Status: The status of the wait duration.

    waitDurationInSeconds
    int

    WaitDurationInSeconds: The wait duration configured in seconds.