Share via

Microsoft.ContainerService fleets 2023-03-15-preview

Bicep resource definition

The fleets resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ContainerService/fleets resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ContainerService/fleets@2023-03-15-preview' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: 'string'
  properties: {
    hubProfile: {
      dnsPrefix: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.ContainerService/fleets

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 63
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ (required)
properties The resource-specific properties for this resource. FleetProperties
scope Use when creating a resource at a scope that is different than the deployment scope. Set this property to the symbolic name of a resource to apply the extension resource.
tags Resource tags Dictionary of tag names and values. See Tags in templates

FleetHubProfile

Name Description Value
dnsPrefix DNS prefix used to create the FQDN for the Fleet hub. string

Constraints:
Min length = 1
Max length = 54
Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9-]{0,52}[a-zA-Z0-9]$

FleetProperties

Name Description Value
hubProfile The FleetHubProfile configures the Fleet's hub. FleetHubProfile

TrackedResourceTags

Name Description Value

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Azure Kubernetes Fleet Manager Deploy a private Hubful Fleet with Azure Kubernetes Fleet Manager
Azure Kubernetes Fleet Manager Deploy a Hubful Fleet with Azure Kubernetes Fleet Manager
Azure Kubernetes Fleet Manager Deploy a Hubless Fleet with Azure Kubernetes Fleet Manager

ARM template resource definition

The fleets resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ContainerService/fleets resource, add the following JSON to your template.

{
  "type": "Microsoft.ContainerService/fleets",
  "apiVersion": "2023-03-15-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "hubProfile": {
      "dnsPrefix": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.ContainerService/fleets

Name Description Value
apiVersion The api version '2023-03-15-preview'
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 63
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ (required)
properties The resource-specific properties for this resource. FleetProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.ContainerService/fleets'

FleetHubProfile

Name Description Value
dnsPrefix DNS prefix used to create the FQDN for the Fleet hub. string

Constraints:
Min length = 1
Max length = 54
Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9-]{0,52}[a-zA-Z0-9]$

FleetProperties

Name Description Value
hubProfile The FleetHubProfile configures the Fleet's hub. FleetHubProfile

TrackedResourceTags

Name Description Value

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Azure Kubernetes Fleet Manager

Deploy to Azure		 Deploy a private Hubful Fleet with Azure Kubernetes Fleet Manager
Azure Kubernetes Fleet Manager

Deploy to Azure		 Deploy a Hubful Fleet with Azure Kubernetes Fleet Manager
Azure Kubernetes Fleet Manager

Deploy to Azure		 Deploy a Hubless Fleet with Azure Kubernetes Fleet Manager

Terraform (AzAPI provider) resource definition

The fleets resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ContainerService/fleets resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ContainerService/fleets@2023-03-15-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      hubProfile = {
        dnsPrefix = "string"
      }
    }
  }
}

Property Values

Microsoft.ContainerService/fleets

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 63
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ (required)
parent_id The ID of the resource to apply this extension resource to. string (required)
properties The resource-specific properties for this resource. FleetProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.ContainerService/fleets@2023-03-15-preview"

FleetHubProfile

Name Description Value
dnsPrefix DNS prefix used to create the FQDN for the Fleet hub. string

Constraints:
Min length = 1
Max length = 54
Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9-]{0,52}[a-zA-Z0-9]$

FleetProperties

Name Description Value
hubProfile The FleetHubProfile configures the Fleet's hub. FleetHubProfile

TrackedResourceTags

Name Description Value

Usage Examples

Terraform Samples

A basic example of deploying Kubernetes Fleet Manager.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westus"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "fleet" {
  type      = "Microsoft.ContainerService/fleets@2024-04-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {}
  }
}
  • Last updated on