Microsoft.ContainerService fleets/members 2023-03-15-preview

Bicep resource definition

The fleets/members 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/members resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ContainerService/fleets/members@2023-03-15-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    clusterResourceId: 'string'
    group: 'string'
  }
}

Property Values

Microsoft.ContainerService/fleets/members

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: fleets
properties The resource-specific properties for this resource. FleetMemberProperties

FleetMemberProperties

Name Description Value
clusterResourceId The ARM resource id of the cluster that joins the Fleet. Must be a valid Azure resource id. e.g.: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{clusterName}'. string (required)
group The group this member belongs to for multi-cluster update management. string

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

Usage Examples

Bicep Samples

A basic example of deploying Kubernetes Fleet Member.

param resourceName string = 'acctest0001'
param location string = 'westus'

resource fleet 'Microsoft.ContainerService/fleets@2024-04-01' = {
  name: resourceName
  location: location
  properties: {}
}

resource managedCluster 'Microsoft.ContainerService/managedClusters@2025-02-01' = {
  name: resourceName
  location: location
  properties: {
    addonProfiles: {}
    agentPoolProfiles: [
      {
        count: 1
        enableAutoScaling: false
        enableEncryptionAtHost: false
        enableFIPS: false
        enableNodePublicIP: false
        enableUltraSSD: false
        kubeletDiskType: ''
        mode: 'System'
        name: 'default'
        nodeLabels: {}
        osDiskType: 'Managed'
        osType: 'Linux'
        scaleDownMode: 'Delete'
        tags: {}
        type: 'VirtualMachineScaleSets'
        upgradeSettings: {
          drainTimeoutInMinutes: 0
          maxSurge: '10%'
          nodeSoakDurationInMinutes: 0
        }
        vmSize: 'Standard_B2s'
      }
    ]
    apiServerAccessProfile: {
      disableRunCommand: false
      enablePrivateCluster: false
      enablePrivateClusterPublicFQDN: false
    }
    autoUpgradeProfile: {
      nodeOSUpgradeChannel: 'NodeImage'
      upgradeChannel: 'none'
    }
    azureMonitorProfile: {
      metrics: {
        enabled: false
      }
    }
    disableLocalAccounts: false
    dnsPrefix: 'acctest0001'
    enableRBAC: true
    kubernetesVersion: ''
    metricsProfile: {
      costAnalysis: {
        enabled: false
      }
    }
    nodeResourceGroup: ''
    securityProfile: {}
    servicePrincipalProfile: {
      clientId: 'msi'
    }
    supportPlan: 'KubernetesOfficial'
  }
  sku: {
    name: 'Base'
    tier: 'Free'
  }
}

resource member 'Microsoft.ContainerService/fleets/members@2024-04-01' = {
  parent: fleet
  name: resourceName
  properties: {
    clusterResourceId: managedCluster.id
    group: 'default'
  }
}

ARM template resource definition

The fleets/members 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/members resource, add the following JSON to your template.

{
  "type": "Microsoft.ContainerService/fleets/members",
  "apiVersion": "2023-03-15-preview",
  "name": "string",
  "properties": {
    "clusterResourceId": "string",
    "group": "string"
  }
}

Property Values

Microsoft.ContainerService/fleets/members

Name Description Value
apiVersion The api version '2023-03-15-preview'
name The resource name string

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ (required)
properties The resource-specific properties for this resource. FleetMemberProperties
type The resource type 'Microsoft.ContainerService/fleets/members'

FleetMemberProperties

Name Description Value
clusterResourceId The ARM resource id of the cluster that joins the Fleet. Must be a valid Azure resource id. e.g.: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{clusterName}'. string (required)
group The group this member belongs to for multi-cluster update management. string

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

Usage Examples

Terraform (AzAPI provider) resource definition

The fleets/members 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/members resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ContainerService/fleets/members@2023-03-15-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      clusterResourceId = "string"
      group = "string"
    }
  }
}

Property Values

Microsoft.ContainerService/fleets/members

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: fleets
properties The resource-specific properties for this resource. FleetMemberProperties
type The resource type "Microsoft.ContainerService/fleets/members@2023-03-15-preview"

FleetMemberProperties

Name Description Value
clusterResourceId The ARM resource id of the cluster that joins the Fleet. Must be a valid Azure resource id. e.g.: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{clusterName}'. string (required)
group The group this member belongs to for multi-cluster update management. string

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

Usage Examples

Terraform Samples

A basic example of deploying Kubernetes Fleet Member.

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" "managedCluster" {
  type      = "Microsoft.ContainerService/managedClusters@2025-02-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  identity {
    type         = "SystemAssigned"
    identity_ids = []
  }
  body = {
    properties = {
      addonProfiles = {}
      agentPoolProfiles = [{
        count                  = 1
        enableAutoScaling      = false
        enableEncryptionAtHost = false
        enableFIPS             = false
        enableNodePublicIP     = false
        enableUltraSSD         = false
        kubeletDiskType        = ""
        mode                   = "System"
        name                   = "default"
        nodeLabels             = {}
        osDiskType             = "Managed"
        osType                 = "Linux"
        scaleDownMode          = "Delete"
        tags                   = {}
        type                   = "VirtualMachineScaleSets"
        upgradeSettings = {
          drainTimeoutInMinutes     = 0
          maxSurge                  = "10%"
          nodeSoakDurationInMinutes = 0
        }
        vmSize = "Standard_B2s"
      }]
      apiServerAccessProfile = {
        disableRunCommand              = false
        enablePrivateCluster           = false
        enablePrivateClusterPublicFQDN = false
      }
      autoUpgradeProfile = {
        nodeOSUpgradeChannel = "NodeImage"
        upgradeChannel       = "none"
      }
      azureMonitorProfile = {
        metrics = {
          enabled = false
        }
      }
      disableLocalAccounts = false
      dnsPrefix            = var.resource_name
      enableRBAC           = true
      kubernetesVersion    = ""
      metricsProfile = {
        costAnalysis = {
          enabled = false
        }
      }
      nodeResourceGroup = ""
      securityProfile   = {}
      servicePrincipalProfile = {
        clientId = "msi"
      }
      supportPlan = "KubernetesOfficial"
    }
    sku = {
      name = "Base"
      tier = "Free"
    }
  }
}

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 = {}
  }
}

resource "azapi_resource" "member" {
  type      = "Microsoft.ContainerService/fleets/members@2024-04-01"
  parent_id = azapi_resource.fleet.id
  name      = var.resource_name
  body = {
    properties = {
      clusterResourceId = azapi_resource.managedCluster.id
      group             = "default"
    }
  }
}
  • Last updated on