Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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@2023-06-15-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
hubProfile: {
agentProfile: {
subnetId: 'string'
}
apiServerAccessProfile: {
enablePrivateCluster: bool
enableVnetIntegration: bool
subnetId: 'string'
}
dnsPrefix: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
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 |
APIServerAccessProfile
| Name | Description | Value |
|---|---|---|
| enablePrivateCluster | Whether to create the Fleet hub as a private cluster or not. | bool |
| enableVnetIntegration | Whether to enable apiserver vnet integration for the Fleet hub or not. | bool |
| subnetId | The subnet to be used when apiserver vnet integration is enabled. It is required when creating a new Fleet with BYO vnet. | string |
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]$ |
FleetProperties
| Name | Description | Value |
|---|---|---|
| hubProfile | The FleetHubProfile configures the Fleet's hub. | FleetHubProfile |
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 |
Microsoft.ContainerService/fleets
| Name | Description | Value |
|---|---|---|
| identity | Managed identity. | ManagedServiceIdentity |
| 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 |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
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": "2023-06-15-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"hubProfile": {
"agentProfile": {
"subnetId": "string"
},
"apiServerAccessProfile": {
"enablePrivateCluster": "bool",
"enableVnetIntegration": "bool",
"subnetId": "string"
},
"dnsPrefix": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
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 |
APIServerAccessProfile
| Name | Description | Value |
|---|---|---|
| enablePrivateCluster | Whether to create the Fleet hub as a private cluster or not. | bool |
| enableVnetIntegration | Whether to enable apiserver vnet integration for the Fleet hub or not. | bool |
| subnetId | The subnet to be used when apiserver vnet integration is enabled. It is required when creating a new Fleet with BYO vnet. | string |
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]$ |
FleetProperties
| Name | Description | Value |
|---|---|---|
| hubProfile | The FleetHubProfile configures the Fleet's hub. | FleetHubProfile |
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 |
Microsoft.ContainerService/fleets
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-06-15-preview' |
| identity | Managed identity. | ManagedServiceIdentity |
| 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' |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
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-06-15-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
hubProfile = {
agentProfile = {
subnetId = "string"
}
apiServerAccessProfile = {
enablePrivateCluster = bool
enableVnetIntegration = bool
subnetId = "string"
}
dnsPrefix = "string"
}
}
}
}
Property Values
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 |
APIServerAccessProfile
| Name | Description | Value |
|---|---|---|
| enablePrivateCluster | Whether to create the Fleet hub as a private cluster or not. | bool |
| enableVnetIntegration | Whether to enable apiserver vnet integration for the Fleet hub or not. | bool |
| subnetId | The subnet to be used when apiserver vnet integration is enabled. It is required when creating a new Fleet with BYO vnet. | string |
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]$ |
FleetProperties
| Name | Description | Value |
|---|---|---|
| hubProfile | The FleetHubProfile configures the Fleet's hub. | FleetHubProfile |
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 |
Microsoft.ContainerService/fleets
| Name | Description | Value |
|---|---|---|
| identity | Managed identity. | ManagedServiceIdentity |
| 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. |
| type | The resource type | "Microsoft.ContainerService/fleets@2023-06-15-preview" |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|