CreateAzureClusterRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/cloudera/main/json-schema/cloudera-create-azure-cluster-request-schema.json",
  "title": "CreateAzureClusterRequest",
  "description": "Request object for the createAzureCluster method.",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cloudera-dw-api-openapi.yml#/components/schemas/CreateAzureClusterRequest",
  "type": "object",
  "required": [
    "environmentCrn",
    "userAssignedManagedIdentity",
    "subnetName"
  ],
  "properties": {
    "environmentCrn": {
      "type": "string",
      "description": "The CRN of the environment for the cluster to create."
    },
    "userAssignedManagedIdentity": {
      "type": "string",
      "description": "Resource ID of the managed identity used by AKS. It is a mandatory parameter for Azure cluster creation."
    },
    "subnetName": {
      "type": "string",
      "description": "Name of Azure subnet where the cluster should be deployed. It is a mandatory parameter for Azure cluster creation."
    },
    "useOverlayNetworking": {
      "type": "boolean",
      "description": "With overlay network nodes get an IP address from the Azure virtual network subnet. Pods receive an IP address from a logically different address space to the Azure virtual network subnet of the nodes."
    },
    "databaseBackupRetentionPeriod": {
      "type": "integer",
      "format": "int32",
      "default": 30,
      "description": "PostgreSQL server backup retention days."
    },
    "whitelistK8sClusterAccessIpCIDRs": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of IP address CIDRs to whitelist for kubernetes cluster access."
    },
    "whitelistWorkloadAccessIpCIDRs": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of IP address CIDRs to whitelist for workload access."
    },
    "useInternalLoadBalancer": {
      "type": "boolean",
      "description": "Set up load balancer with private IP address. An internal load balancer gets created. Make sure there is connectivity between your client network and the network VNet where CDW environment is deployed."
    },
    "customRegistryOptions": {
      "description": "Options for custom ACR/ECR registries.",
      "$ref": "#/$defs/CustomRegistryOptions"
    },
    "customSubdomain": {
      "type": "string",
      "description": "Custom environment subdomain. Overrides the environment subdomain using a customized domain either in the old subdomain format like ENV_ID.dw or the new format like dw-ENV_NAME."
    },
    "enableAZ": {
      "type": "boolean",
      "description": "Enables Azure Availability Zones for the cluster deployment."
    },
    "enableSpotInstances": {
      "type": "boolean",
      "description": "Whether to enable spot instances for Virtual warehouses. It cannot be updated later. Defaults to false.",
      "default": false
    },
    "logAnalyticsWorkspaceId": {
      "type": "string",
      "description": "Enable monitoring of Azure Kubernetes Service (AKS) cluster. Workspace ID for Azure log analytics."
    },
    "outboundType": {
      "type": "string",
      "description": "Network outbound type. This setting controls the egress traffic for cluster nodes in Azure Kubernetes Service. Please refer to the following AKS documentation on the Azure portal. https://learn.microsoft.com/en-us/azure/aks/egress-outboundtype, https://learn.microsoft.com/en-us/azure/aks/nat-gateway",
      "enum": [
        "LoadBalancer",
        "UserAssignedNATGateway",
        "UserDefinedRouting"
      ]
    },
    "aksPodCIDR": {
      "type": "string",
      "description": "Pod CIDR required for Azure CNI networking. Please refer to the following Azure documentation, https://docs.microsoft.com/en-us/azure/aks/azure-cni-overlay."
    },
    "enablePrivateSQL": {
      "type": "boolean",
      "description": "Enables private SQL for the cluster deployment.",
      "default": false
    },
    "privateSQLSubnetName": {
      "type": "string",
      "description": "Name of the delegated subnet where the private SQL should be deployed."
    },
    "privateDNSZoneSQL": {
      "type": "string",
      "description": "Private DNS zone ID for the PostgreSQL server."
    },
    "privateDNSZoneAKS": {
      "type": "string",
      "description": "Private DNS zone AKS resource ID."
    },
    "enablePrivateAks": {
      "type": "boolean",
      "description": "Enable Azure Private AKS mode.",
      "default": false
    }
  },
  "$defs": {
    "CustomRegistryOptions": {
      "type": "object",
      "description": "Options for custom ACR, ECR registry.",
      "properties": {
        "registryType": {
          "enum": [
            "ACR",
            "ECR"
          ],
          "type": "string",
          "description": "Custom registry type."
        },
        "repositoryUrl": {
          "type": "string",
          "description": "URL of the custom image repository.",
          "x-no-paramfile": true
        }
      }
    }
  }
}