azure-resource-manager-schemas/schemas/2024-01-01/Microsoft.Kubernetes.json

{
  "id": "https://schema.management.azure.com/schemas/2024-01-01/Microsoft.Kubernetes.json#",
  "title": "Microsoft.Kubernetes",
  "description": "Microsoft Kubernetes Resource Types",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "resourceDefinitions": {
    "connectedClusters": {
      "description": "Microsoft.Kubernetes/connectedClusters",
      "properties": {
        "apiVersion": {
          "enum": [
            "2024-01-01"
          ],
          "type": "string"
        },
        "identity": {
          "description": "The identity of the connected cluster.",
          "oneOf": [
            {
              "$ref": "#/definitions/ConnectedClusterIdentity"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "kind": {
          "description": "The kind of connected cluster.",
          "oneOf": [
            {
              "enum": [
                "ProvisionedCluster"
              ],
              "type": "string"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "location": {
          "description": "The geo-location where the resource lives",
          "type": "string"
        },
        "name": {
          "description": "The name of the Kubernetes cluster on which get is called.",
          "type": "string"
        },
        "properties": {
          "description": "Describes the connected cluster resource properties.",
          "oneOf": [
            {
              "$ref": "#/definitions/ConnectedClusterProperties"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "tags": {
          "description": "Resource tags.",
          "oneOf": [
            {
              "additionalProperties": {
                "type": "string"
              },
              "properties": {},
              "type": "object"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "type": {
          "enum": [
            "Microsoft.Kubernetes/connectedClusters"
          ],
          "type": "string"
        }
      },
      "required": [
        "name",
        "properties",
        "apiVersion",
        "type"
      ],
      "type": "object"
    }
  },
  "definitions": {
    "AadProfile": {
      "description": "AAD Profile specifies attributes for Azure Active Directory integration.",
      "properties": {
        "adminGroupObjectIDs": {
          "description": "The list of AAD group object IDs that will have admin role of the cluster.",
          "oneOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "enableAzureRBAC": {
          "description": "Whether to enable Azure RBAC for Kubernetes authorization.",
          "oneOf": [
            {
              "type": "boolean"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "tenantID": {
          "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "ArcAgentProfile": {
      "description": "Defines the Arc Agent properties for the clusters.",
      "properties": {
        "agentAutoUpgrade": {
          "description": "Indicates whether the Arc agents on the be upgraded automatically to the latest version. Defaults to Enabled.",
          "oneOf": [
            {
              "enum": [
                "Enabled",
                "Disabled"
              ],
              "type": "string"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "desiredAgentVersion": {
          "description": "Version of the Arc agents to be installed on the cluster resource",
          "type": "string"
        }
      },
      "type": "object"
    },
    "ConnectedClusterIdentity": {
      "description": "Identity for the connected cluster.",
      "properties": {
        "type": {
          "description": "The type of identity used for the connected cluster. The type 'SystemAssigned, includes a system created identity. The type 'None' means no identity is assigned to the connected cluster.",
          "oneOf": [
            {
              "enum": [
                "None",
                "SystemAssigned"
              ],
              "type": "string"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        }
      },
      "required": [
        "type"
      ],
      "type": "object"
    },
    "ConnectedClusterProperties": {
      "description": "Properties of the connected cluster.",
      "properties": {
        "aadProfile": {
          "description": "AAD profile for the connected cluster.",
          "oneOf": [
            {
              "$ref": "#/definitions/AadProfile"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "agentPublicKeyCertificate": {
          "description": "Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure.",
          "type": "string"
        },
        "arcAgentProfile": {
          "description": "Arc agentry configuration for the provisioned cluster.",
          "oneOf": [
            {
              "$ref": "#/definitions/ArcAgentProfile"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "azureHybridBenefit": {
          "description": "Indicates whether Azure Hybrid Benefit is opted in",
          "oneOf": [
            {
              "enum": [
                "True",
                "False",
                "NotApplicable"
              ],
              "type": "string"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "distribution": {
          "description": "The Kubernetes distribution running on this connected cluster.",
          "type": "string"
        },
        "distributionVersion": {
          "description": "The Kubernetes distribution version on this connected cluster.",
          "type": "string"
        },
        "infrastructure": {
          "description": "The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.",
          "type": "string"
        },
        "privateLinkScopeResourceId": {
          "description": "The resource id of the private link scope this connected cluster is assigned to, if any.",
          "type": "string"
        },
        "privateLinkState": {
          "description": "Property which describes the state of private link on a connected cluster resource.",
          "oneOf": [
            {
              "enum": [
                "Enabled",
                "Disabled"
              ],
              "type": "string"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        },
        "provisioningState": {
          "description": "Provisioning state of the connected cluster resource.",
          "oneOf": [
            {
              "enum": [
                "Succeeded",
                "Failed",
                "Canceled",
                "Provisioning",
                "Updating",
                "Deleting",
                "Accepted"
              ],
              "type": "string"
            },
            {
              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
            }
          ]
        }
      },
      "required": [
        "agentPublicKeyCertificate"
      ],
      "type": "object"
    }
  }
}