Share via

Microsoft.ContainerService fleets 2023-03-15-preview

  • Article

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' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    hubProfile: {
      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
properties The resource-specific properties for this resource. FleetProperties

FleetProperties

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

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]$

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",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "hubProfile": {
      "dnsPrefix": "string"
    }
  }
}

Property values

fleets

Name Description Value
type The resource type 'Microsoft.ContainerService/fleets'
apiVersion The resource api version '2023-03-15-preview'
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
properties The resource-specific properties for this resource. FleetProperties

FleetProperties

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

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]$

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@2023-03-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      hubProfile = {
        dnsPrefix = "string"
      }
    }
  })
}

Property values

fleets

Name Description Value
type The resource type "Microsoft.ContainerService/fleets@2023-03-15-preview"
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.
properties The resource-specific properties for this resource. FleetProperties

FleetProperties

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

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]$