Share via

Microsoft.ContainerService fleets 2022-09-02-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@2022-09-02-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    hubProfile: {
      dnsPrefix: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

FleetHubProfile

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

Constraints:
Min length = 1
Max length = 1
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

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 = 1
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

TrackedResourceTags

Name Description Value

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": "2022-09-02-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "hubProfile": {
      "dnsPrefix": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

FleetHubProfile

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

Constraints:
Min length = 1
Max length = 1
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

Microsoft.ContainerService/fleets

Name Description Value
apiVersion The api version '2022-09-02-preview'
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 1
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'

TrackedResourceTags

Name Description Value

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@2022-09-02-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      hubProfile = {
        dnsPrefix = "string"
      }
    }
  })
}

Property values

FleetHubProfile

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

Constraints:
Min length = 1
Max length = 1
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

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 = 1
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.
type The resource type "Microsoft.ContainerService/fleets@2022-09-02-preview"

TrackedResourceTags

Name Description Value