Bicep resource definition
The provisionedClusters/agentPools resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.HybridContainerService/provisionedClusters/agentPools resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.HybridContainerService/provisionedClusters/agentPools@2022-09-01-preview' = {
parent: resourceSymbolicName
extendedLocation: {
name: 'string'
type: 'string'
}
location: 'string'
name: 'string'
properties: {
availabilityZones: [
'string'
]
cloudProviderProfile: {
infraNetworkProfile: {
vnetSubnetIds: [
'string'
]
}
infraStorageProfile: {
storageSpaceIds: [
'string'
]
}
}
count: int
maxCount: int
maxPods: int
minCount: int
mode: 'string'
nodeImageVersion: 'string'
nodeLabels: {
{customized property}: 'string'
}
nodeTaints: [
'string'
]
osType: 'string'
status: {
errorMessage: 'string'
provisioningStatus: {
error: {
code: 'string'
message: 'string'
}
operationId: 'string'
phase: 'string'
status: 'string'
}
readyReplicas: int
replicas: int
}
vmSize: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.HybridContainerService/provisionedClusters/agentPools
| Name |
Description |
Value |
| extendedLocation |
|
AgentPoolExtendedLocation |
| location |
The resource location |
string |
| name |
The resource name |
string
Constraints:
Min length = 3
Max length = 64 (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: provisionedClusters |
| properties |
|
AgentPoolProperties |
| tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
AgentPoolExtendedLocation
| Name |
Description |
Value |
| name |
The extended location name. |
string |
| type |
The extended location type. |
string |
AgentPoolProfileNodeLabels
AgentPoolProperties
| Name |
Description |
Value |
| availabilityZones |
AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones |
string[] |
| cloudProviderProfile |
The underlying cloud infra provider properties. |
CloudProviderProfile |
| count |
Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. |
int |
| maxCount |
The maximum number of nodes for auto-scaling |
int |
| maxPods |
The maximum number of pods that can run on a node. |
int |
| minCount |
The minimum number of nodes for auto-scaling |
int |
| mode |
Mode - AgentPoolMode represents mode of an agent pool. Possible values include: 'System', 'LB', 'User'. Default is 'User' |
'LB'
'System'
'User' |
| nodeImageVersion |
The version of node image |
string |
| nodeLabels |
NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool. |
AgentPoolProfileNodeLabels |
| nodeTaints |
NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. |
string[] |
| osType |
OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows' |
'Linux'
'Windows' |
| status |
HybridAKSNodePoolStatus defines the observed state of HybridAKSNodePool |
AgentPoolProvisioningStatusStatus |
| vmSize |
VmSize - The size of the agent pool VMs. |
string |
AgentPoolProvisioningStatusError
| Name |
Description |
Value |
| code |
|
string |
| message |
|
string |
AgentPoolProvisioningStatusStatus
| Name |
Description |
Value |
| errorMessage |
ErrorMessage - Error messages during creation of cluster |
string |
| provisioningStatus |
Contains Provisioning errors |
AgentPoolProvisioningStatusStatusProvisioningStatus |
| readyReplicas |
Total number of ready machines targeted by this deployment. |
int |
| replicas |
Total number of non-terminated machines targeted by this deployment |
int |
AgentPoolProvisioningStatusStatusProvisioningStatus
| Name |
Description |
Value |
| error |
|
AgentPoolProvisioningStatusError |
| operationId |
|
string |
| phase |
Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc. |
string |
| status |
|
string |
CloudProviderProfile
CloudProviderProfileInfraNetworkProfile
| Name |
Description |
Value |
| vnetSubnetIds |
Array of references to azure resource corresponding to the new HybridAKSNetwork object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName} |
string[] |
CloudProviderProfileInfraStorageProfile
| Name |
Description |
Value |
| storageSpaceIds |
Reference to azure resource corresponding to the new HybridAKSStorage object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/storageSpaces/{storageSpaceName} |
string[] |
ARM template resource definition
The provisionedClusters/agentPools resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.HybridContainerService/provisionedClusters/agentPools resource, add the following JSON to your template.
{
"type": "Microsoft.HybridContainerService/provisionedClusters/agentPools",
"apiVersion": "2022-09-01-preview",
"name": "string",
"extendedLocation": {
"name": "string",
"type": "string"
},
"location": "string",
"properties": {
"availabilityZones": [ "string" ],
"cloudProviderProfile": {
"infraNetworkProfile": {
"vnetSubnetIds": [ "string" ]
},
"infraStorageProfile": {
"storageSpaceIds": [ "string" ]
}
},
"count": "int",
"maxCount": "int",
"maxPods": "int",
"minCount": "int",
"mode": "string",
"nodeImageVersion": "string",
"nodeLabels": {
"{customized property}": "string"
},
"nodeTaints": [ "string" ],
"osType": "string",
"status": {
"errorMessage": "string",
"provisioningStatus": {
"error": {
"code": "string",
"message": "string"
},
"operationId": "string",
"phase": "string",
"status": "string"
},
"readyReplicas": "int",
"replicas": "int"
},
"vmSize": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.HybridContainerService/provisionedClusters/agentPools
| Name |
Description |
Value |
| apiVersion |
The api version |
'2022-09-01-preview' |
| extendedLocation |
|
AgentPoolExtendedLocation |
| location |
The resource location |
string |
| name |
The resource name |
string
Constraints:
Min length = 3
Max length = 64 (required) |
| properties |
|
AgentPoolProperties |
| tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
| type |
The resource type |
'Microsoft.HybridContainerService/provisionedClusters/agentPools' |
AgentPoolExtendedLocation
| Name |
Description |
Value |
| name |
The extended location name. |
string |
| type |
The extended location type. |
string |
AgentPoolProfileNodeLabels
AgentPoolProperties
| Name |
Description |
Value |
| availabilityZones |
AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones |
string[] |
| cloudProviderProfile |
The underlying cloud infra provider properties. |
CloudProviderProfile |
| count |
Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. |
int |
| maxCount |
The maximum number of nodes for auto-scaling |
int |
| maxPods |
The maximum number of pods that can run on a node. |
int |
| minCount |
The minimum number of nodes for auto-scaling |
int |
| mode |
Mode - AgentPoolMode represents mode of an agent pool. Possible values include: 'System', 'LB', 'User'. Default is 'User' |
'LB'
'System'
'User' |
| nodeImageVersion |
The version of node image |
string |
| nodeLabels |
NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool. |
AgentPoolProfileNodeLabels |
| nodeTaints |
NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. |
string[] |
| osType |
OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows' |
'Linux'
'Windows' |
| status |
HybridAKSNodePoolStatus defines the observed state of HybridAKSNodePool |
AgentPoolProvisioningStatusStatus |
| vmSize |
VmSize - The size of the agent pool VMs. |
string |
AgentPoolProvisioningStatusError
| Name |
Description |
Value |
| code |
|
string |
| message |
|
string |
AgentPoolProvisioningStatusStatus
| Name |
Description |
Value |
| errorMessage |
ErrorMessage - Error messages during creation of cluster |
string |
| provisioningStatus |
Contains Provisioning errors |
AgentPoolProvisioningStatusStatusProvisioningStatus |
| readyReplicas |
Total number of ready machines targeted by this deployment. |
int |
| replicas |
Total number of non-terminated machines targeted by this deployment |
int |
AgentPoolProvisioningStatusStatusProvisioningStatus
| Name |
Description |
Value |
| error |
|
AgentPoolProvisioningStatusError |
| operationId |
|
string |
| phase |
Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc. |
string |
| status |
|
string |
CloudProviderProfile
CloudProviderProfileInfraNetworkProfile
| Name |
Description |
Value |
| vnetSubnetIds |
Array of references to azure resource corresponding to the new HybridAKSNetwork object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName} |
string[] |
CloudProviderProfileInfraStorageProfile
| Name |
Description |
Value |
| storageSpaceIds |
Reference to azure resource corresponding to the new HybridAKSStorage object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/storageSpaces/{storageSpaceName} |
string[] |
Usage Examples
The provisionedClusters/agentPools resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.HybridContainerService/provisionedClusters/agentPools resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.HybridContainerService/provisionedClusters/agentPools@2022-09-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
extendedLocation = {
name = "string"
type = "string"
}
properties = {
availabilityZones = [
"string"
]
cloudProviderProfile = {
infraNetworkProfile = {
vnetSubnetIds = [
"string"
]
}
infraStorageProfile = {
storageSpaceIds = [
"string"
]
}
}
count = int
maxCount = int
maxPods = int
minCount = int
mode = "string"
nodeImageVersion = "string"
nodeLabels = {
{customized property} = "string"
}
nodeTaints = [
"string"
]
osType = "string"
status = {
errorMessage = "string"
provisioningStatus = {
error = {
code = "string"
message = "string"
}
operationId = "string"
phase = "string"
status = "string"
}
readyReplicas = int
replicas = int
}
vmSize = "string"
}
}
}
Property Values
Microsoft.HybridContainerService/provisionedClusters/agentPools
| Name |
Description |
Value |
| extendedLocation |
|
AgentPoolExtendedLocation |
| location |
The resource location |
string |
| name |
The resource name |
string
Constraints:
Min length = 3
Max length = 64 (required) |
| parent_id |
The ID of the resource that is the parent for this resource. |
ID for resource of type: provisionedClusters |
| properties |
|
AgentPoolProperties |
| tags |
Resource tags |
Dictionary of tag names and values. |
| type |
The resource type |
"Microsoft.HybridContainerService/provisionedClusters/agentPools@2022-09-01-preview" |
AgentPoolExtendedLocation
| Name |
Description |
Value |
| name |
The extended location name. |
string |
| type |
The extended location type. |
string |
AgentPoolProfileNodeLabels
AgentPoolProperties
| Name |
Description |
Value |
| availabilityZones |
AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones |
string[] |
| cloudProviderProfile |
The underlying cloud infra provider properties. |
CloudProviderProfile |
| count |
Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. |
int |
| maxCount |
The maximum number of nodes for auto-scaling |
int |
| maxPods |
The maximum number of pods that can run on a node. |
int |
| minCount |
The minimum number of nodes for auto-scaling |
int |
| mode |
Mode - AgentPoolMode represents mode of an agent pool. Possible values include: 'System', 'LB', 'User'. Default is 'User' |
'LB'
'System'
'User' |
| nodeImageVersion |
The version of node image |
string |
| nodeLabels |
NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool. |
AgentPoolProfileNodeLabels |
| nodeTaints |
NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. |
string[] |
| osType |
OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows' |
'Linux'
'Windows' |
| status |
HybridAKSNodePoolStatus defines the observed state of HybridAKSNodePool |
AgentPoolProvisioningStatusStatus |
| vmSize |
VmSize - The size of the agent pool VMs. |
string |
AgentPoolProvisioningStatusError
| Name |
Description |
Value |
| code |
|
string |
| message |
|
string |
AgentPoolProvisioningStatusStatus
| Name |
Description |
Value |
| errorMessage |
ErrorMessage - Error messages during creation of cluster |
string |
| provisioningStatus |
Contains Provisioning errors |
AgentPoolProvisioningStatusStatusProvisioningStatus |
| readyReplicas |
Total number of ready machines targeted by this deployment. |
int |
| replicas |
Total number of non-terminated machines targeted by this deployment |
int |
AgentPoolProvisioningStatusStatusProvisioningStatus
| Name |
Description |
Value |
| error |
|
AgentPoolProvisioningStatusError |
| operationId |
|
string |
| phase |
Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc. |
string |
| status |
|
string |
CloudProviderProfile
CloudProviderProfileInfraNetworkProfile
| Name |
Description |
Value |
| vnetSubnetIds |
Array of references to azure resource corresponding to the new HybridAKSNetwork object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks/{virtualNetworkName} |
string[] |
CloudProviderProfileInfraStorageProfile
| Name |
Description |
Value |
| storageSpaceIds |
Reference to azure resource corresponding to the new HybridAKSStorage object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/storageSpaces/{storageSpaceName} |
string[] |