Microsoft.ContainerService fleets

Article
08/14/2024

Bicep resource definition

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

Resource groups - See resource group deployment commands

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@2024-04-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    hubProfile: {
      agentProfile: {
        subnetId: 'string'
        vmSize: 'string'
      }
      apiServerAccessProfile: {
        enablePrivateCluster: bool
      }
      dnsPrefix: 'string'
    }
  }
}

Property values

fleets

Name	Description	Value
name	The resource name	string (required)
location	The geo-location where the resource lives	string (required)
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
identity	Managed identity.	ManagedServiceIdentity
properties	The resource-specific properties for this resource.	FleetProperties

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities

UserAssignedIdentities

Name	Description	Value
{customized property}		UserAssignedIdentity

UserAssignedIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

FleetProperties

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

FleetHubProfile

Name	Description	Value
agentProfile	The agent profile for the Fleet hub.	AgentProfile
apiServerAccessProfile	The access profile for the Fleet hub API server.	APIServerAccessProfile
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]$`

AgentProfile

Name	Description	Value
subnetId	The ID of the subnet which the Fleet hub node will join on startup. If this is not specified, a vnet and subnet will be generated and used.	string
vmSize	The virtual machine size of the Fleet hub.	string

APIServerAccessProfile

Name	Description	Value
enablePrivateCluster	Whether to create the Fleet hub as a private cluster or not.	bool

ARM template resource definition

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

Resource groups - See resource group deployment commands

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": "2024-04-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "hubProfile": {
      "agentProfile": {
        "subnetId": "string",
        "vmSize": "string"
      },
      "apiServerAccessProfile": {
        "enablePrivateCluster": "bool"
      },
      "dnsPrefix": "string"
    }
  }
}

Property values

fleets

Name	Description	Value
type	The resource type	'Microsoft.ContainerService/fleets'
apiVersion	The resource api version	'2024-04-01'
name	The resource name	string (required)
location	The geo-location where the resource lives	string (required)
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
identity	Managed identity.	ManagedServiceIdentity
properties	The resource-specific properties for this resource.	FleetProperties

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities

UserAssignedIdentities

Name	Description	Value
{customized property}		UserAssignedIdentity

UserAssignedIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

FleetProperties

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

FleetHubProfile

Name	Description	Value
agentProfile	The agent profile for the Fleet hub.	AgentProfile
apiServerAccessProfile	The access profile for the Fleet hub API server.	APIServerAccessProfile
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]$`

AgentProfile

Name	Description	Value
subnetId	The ID of the subnet which the Fleet hub node will join on startup. If this is not specified, a vnet and subnet will be generated and used.	string
vmSize	The virtual machine size of the Fleet hub.	string

APIServerAccessProfile

Name	Description	Value
enablePrivateCluster	Whether to create the Fleet hub as a private cluster or not.	bool

Terraform (AzAPI provider) resource definition

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

Resource groups

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@2024-04-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      hubProfile = {
        agentProfile = {
          subnetId = "string"
          vmSize = "string"
        }
        apiServerAccessProfile = {
          enablePrivateCluster = bool
        }
        dnsPrefix = "string"
      }
    }
  })
}

Property values

fleets

Name	Description	Value
type	The resource type	"Microsoft.ContainerService/fleets@2024-04-01"
name	The resource name	string (required)
location	The geo-location where the resource lives	string (required)
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	Resource tags.	Dictionary of tag names and values.
identity	Managed identity.	ManagedServiceIdentity
properties	The resource-specific properties for this resource.	FleetProperties

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	"SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" (required)
identity_ids	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	Array of user identity IDs.

UserAssignedIdentities

Name	Description	Value
{customized property}		UserAssignedIdentity

UserAssignedIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

FleetProperties

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

FleetHubProfile

Name	Description	Value
agentProfile	The agent profile for the Fleet hub.	AgentProfile
apiServerAccessProfile	The access profile for the Fleet hub API server.	APIServerAccessProfile
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]$`

AgentProfile

Name	Description	Value
subnetId	The ID of the subnet which the Fleet hub node will join on startup. If this is not specified, a vnet and subnet will be generated and used.	string
vmSize	The virtual machine size of the Fleet hub.	string

APIServerAccessProfile

Name	Description	Value
enablePrivateCluster	Whether to create the Fleet hub as a private cluster or not.	bool

Share via

Microsoft.ContainerService fleets

Bicep resource definition

Resource format

Property values

fleets

ManagedServiceIdentity

UserAssignedIdentities

UserAssignedIdentity

FleetProperties

FleetHubProfile

AgentProfile

APIServerAccessProfile

ARM template resource definition

Resource format

Property values

fleets

ManagedServiceIdentity

UserAssignedIdentities

UserAssignedIdentity

FleetProperties

FleetHubProfile

AgentProfile

APIServerAccessProfile

Terraform (AzAPI provider) resource definition

Resource format

Property values

fleets

ManagedServiceIdentity

UserAssignedIdentities

UserAssignedIdentity

FleetProperties

FleetHubProfile

AgentProfile

APIServerAccessProfile

Feedback

Additional resources