Skip to main content

Updates the cluster configuration information

PUT 
/v1/cloudconfigs/azure/:configUid/clusterConfig

Updates the cluster configuration information

Request​

Path Parameters

    configUid stringrequired

    Cluster's cloud config uid

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Body

    clusterConfig

    object

    Cluster level configuration for Azure cloud and applicable for all the machine pools

    aadProfile

    object

    AadProfile is Azure Active Directory configuration to integrate with AKS for aad authentication.

    adminGroupObjectIDsstring[]required

    AdminGroupObjectIDs - AAD group object IDs that will have admin role of the cluster.

    managedbooleanrequired

    Managed - Whether to enable managed AAD.

    apiServerAccessProfile

    object

    APIServerAccessProfile is the access profile for AKS API server.

    authorizedIPRangesstring[]

    AuthorizedIPRanges - Authorized IP Ranges to kubernetes API server.

    enablePrivateClusterboolean

    EnablePrivateCluster - Whether to create the cluster as a private cluster or not.

    enablePrivateClusterPublicFQDNboolean

    EnablePrivateClusterPublicFQDN - Whether to create additional public FQDN for private cluster or not.

    privateDNSZonestring

    PrivateDNSZone - Private dns zone mode for private cluster.

    containerNamestring

    controlPlaneSubnet

    object

    Subnet for Kubernetes control-plane node

    cidrBlockstring

    CidrBlock is the CIDR block to be used when the provider creates a managed Vnet.

    namestring
    securityGroupNamestring

    Network Security Group(NSG) to be attached to subnet. NSG for a control plane subnet, should allow inbound to port 6443, as port 6443 is used by kubeadm to bootstrap the control planes

    enablePrivateClusterboolean

    Deprecated. use apiServerAccessProfile.enablePrivateCluster

    infraLBConfig

    object

    APIServerLB is the configuration for the control-plane load balancer.

    apiServerLB

    object

    APIServerLB is the configuration for the control-plane load balancer.

    apiServerLBStaticIPstring
    ipAllocationMethodstring

    Possible values: [Static, Dynamic]

    Default value: Dynamic

    privateDNSNamestring
    typestring

    Possible values: [Internal, Public]

    Default value: Public

    Load Balancer type

    locationstringrequired

    Location is the Azure datacenter location

    resourceGroupstring
    sshKeystringrequired
    storageAccountNamestring
    subscriptionIdstringrequired

    Subscription ID is unique identifier for the subscription used to access Azure services

    vnetCidrBlockstring
    vnetNamestring

    VNETName is the virtual network in which the cluster is to be provisioned.

    vnetResourceGroupstring

    workerSubnet

    object

    Subnet for Kubernetes worker node

    cidrBlockstring

    CidrBlock is the CIDR block to be used when the provider creates a managed Vnet.

    namestring
    securityGroupNamestring

    Network Security Group(NSG) to be attached to subnet. NSG for a control plane subnet, should allow inbound to port 6443, as port 6443 is used by kubeadm to bootstrap the control planes

Responses​

The resource was updated successfully

Loading...