Microsoft.KubernetesConfiguration extensions 2022-03-01
Bicep resource definition
The extensions resource type is an extension resource, which means you can apply it to another resource.
Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in Bicep.
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.KubernetesConfiguration/extensions resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.KubernetesConfiguration/extensions@2022-03-01' = {
name: 'string'
scope: resourceSymbolicName
identity: {
type: 'SystemAssigned'
}
properties: {
aksAssignedIdentity: {
type: 'string'
}
autoUpgradeMinorVersion: bool
configurationProtectedSettings: {}
configurationSettings: {}
extensionType: 'string'
releaseTrain: 'string'
scope: {
cluster: {
releaseNamespace: 'string'
}
namespace: {
targetNamespace: 'string'
}
}
statuses: [
{
code: 'string'
displayStatus: 'string'
level: 'string'
message: 'string'
time: 'string'
}
]
version: 'string'
}
}
Property values
extensions
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| scope | Use when creating an extension resource at a scope that is different than the deployment scope. | Target resource For Bicep, set this property to the symbolic name of the resource to apply the extension resource. |
| identity | Identity of the Extension resource | Identity |
| properties | Properties of an Extension resource | ExtensionProperties |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' |
ExtensionProperties
| Name | Description | Value |
|---|---|---|
| aksAssignedIdentity | Identity of the Extension resource in an AKS cluster | ExtensionPropertiesAksAssignedIdentity |
| autoUpgradeMinorVersion | Flag to note if this extension participates in auto upgrade of minor version, or not. | bool |
| configurationProtectedSettings | Configuration settings that are sensitive, as name-value pairs for configuring this extension. | object |
| configurationSettings | Configuration settings, as name-value pairs for configuring this extension. | object |
| extensionType | Type of the Extension, of which this resource is an instance of. It must be one of the Extension Types registered with Microsoft.KubernetesConfiguration by the Extension publisher. | string |
| releaseTrain | ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'. | string |
| scope | Scope at which the extension is installed. | Scope |
| statuses | Status from this extension. | ExtensionStatus[] |
| version | User-specified version of the extension for this extension to 'pin'. To use 'version', autoUpgradeMinorVersion must be 'false'. | string |
ExtensionPropertiesAksAssignedIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' 'UserAssigned' |
Scope
| Name | Description | Value |
|---|---|---|
| cluster | Specifies that the scope of the extension is Cluster | ScopeCluster |
| namespace | Specifies that the scope of the extension is Namespace | ScopeNamespace |
ScopeCluster
| Name | Description | Value |
|---|---|---|
| releaseNamespace | Namespace where the extension Release must be placed, for a Cluster scoped extension. If this namespace does not exist, it will be created | string |
ScopeNamespace
| Name | Description | Value |
|---|---|---|
| targetNamespace | Namespace where the extension will be created for an Namespace scoped extension. If this namespace does not exist, it will be created | string |
ExtensionStatus
| Name | Description | Value |
|---|---|---|
| code | Status code provided by the Extension | string |
| displayStatus | Short description of status of the extension. | string |
| level | Level of the status. | 'Error' 'Information' 'Warning' |
| message | Detailed message of the status from the Extension. | string |
| time | DateLiteral (per ISO8601) noting the time of installation status. | string |
ARM template resource definition
The extensions resource type is an extension resource, which means you can apply it to another resource.
Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in ARM templates.
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.KubernetesConfiguration/extensions resource, add the following JSON to your template.
{
"type": "Microsoft.KubernetesConfiguration/extensions",
"apiVersion": "2022-03-01",
"name": "string",
"scope": "string",
"identity": {
"type": "SystemAssigned"
},
"properties": {
"aksAssignedIdentity": {
"type": "string"
},
"autoUpgradeMinorVersion": "bool",
"configurationProtectedSettings": {},
"configurationSettings": {},
"extensionType": "string",
"releaseTrain": "string",
"scope": {
"cluster": {
"releaseNamespace": "string"
},
"namespace": {
"targetNamespace": "string"
}
},
"statuses": [
{
"code": "string",
"displayStatus": "string",
"level": "string",
"message": "string",
"time": "string"
}
],
"version": "string"
}
}
Property values
extensions
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.KubernetesConfiguration/extensions' |
| apiVersion | The resource api version | '2022-03-01' |
| name | The resource name | string (required) |
| scope | Use when creating an extension resource at a scope that is different than the deployment scope. | Target resource For JSON, set the value to the full name of the resource to apply the extension resource to. |
| identity | Identity of the Extension resource | Identity |
| properties | Properties of an Extension resource | ExtensionProperties |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' |
ExtensionProperties
| Name | Description | Value |
|---|---|---|
| aksAssignedIdentity | Identity of the Extension resource in an AKS cluster | ExtensionPropertiesAksAssignedIdentity |
| autoUpgradeMinorVersion | Flag to note if this extension participates in auto upgrade of minor version, or not. | bool |
| configurationProtectedSettings | Configuration settings that are sensitive, as name-value pairs for configuring this extension. | object |
| configurationSettings | Configuration settings, as name-value pairs for configuring this extension. | object |
| extensionType | Type of the Extension, of which this resource is an instance of. It must be one of the Extension Types registered with Microsoft.KubernetesConfiguration by the Extension publisher. | string |
| releaseTrain | ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'. | string |
| scope | Scope at which the extension is installed. | Scope |
| statuses | Status from this extension. | ExtensionStatus[] |
| version | User-specified version of the extension for this extension to 'pin'. To use 'version', autoUpgradeMinorVersion must be 'false'. | string |
ExtensionPropertiesAksAssignedIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' 'UserAssigned' |
Scope
| Name | Description | Value |
|---|---|---|
| cluster | Specifies that the scope of the extension is Cluster | ScopeCluster |
| namespace | Specifies that the scope of the extension is Namespace | ScopeNamespace |
ScopeCluster
| Name | Description | Value |
|---|---|---|
| releaseNamespace | Namespace where the extension Release must be placed, for a Cluster scoped extension. If this namespace does not exist, it will be created | string |
ScopeNamespace
| Name | Description | Value |
|---|---|---|
| targetNamespace | Namespace where the extension will be created for an Namespace scoped extension. If this namespace does not exist, it will be created | string |
ExtensionStatus
| Name | Description | Value |
|---|---|---|
| code | Status code provided by the Extension | string |
| displayStatus | Short description of status of the extension. | string |
| level | Level of the status. | 'Error' 'Information' 'Warning' |
| message | Detailed message of the status from the Extension. | string |
| time | DateLiteral (per ISO8601) noting the time of installation status. | string |
Terraform (AzAPI provider) resource definition
The extensions resource type is an extension resource, which means you can apply it to another resource.
Use the parent_id property on this resource to set the scope for this resource.
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.KubernetesConfiguration/extensions resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KubernetesConfiguration/extensions@2022-03-01"
name = "string"
parent_id = "string"
identity {
type = "SystemAssigned"
}
body = jsonencode({
properties = {
aksAssignedIdentity = {
type = "string"
}
autoUpgradeMinorVersion = bool
configurationProtectedSettings = {}
configurationSettings = {}
extensionType = "string"
releaseTrain = "string"
scope = {
cluster = {
releaseNamespace = "string"
}
namespace = {
targetNamespace = "string"
}
}
statuses = [
{
code = "string"
displayStatus = "string"
level = "string"
message = "string"
time = "string"
}
]
version = "string"
}
})
}
Property values
extensions
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.KubernetesConfiguration/extensions@2022-03-01" |
| name | The resource name | string (required) |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| identity | Identity of the Extension resource | Identity |
| properties | Properties of an Extension resource | ExtensionProperties |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | "SystemAssigned" |
ExtensionProperties
| Name | Description | Value |
|---|---|---|
| aksAssignedIdentity | Identity of the Extension resource in an AKS cluster | ExtensionPropertiesAksAssignedIdentity |
| autoUpgradeMinorVersion | Flag to note if this extension participates in auto upgrade of minor version, or not. | bool |
| configurationProtectedSettings | Configuration settings that are sensitive, as name-value pairs for configuring this extension. | object |
| configurationSettings | Configuration settings, as name-value pairs for configuring this extension. | object |
| extensionType | Type of the Extension, of which this resource is an instance of. It must be one of the Extension Types registered with Microsoft.KubernetesConfiguration by the Extension publisher. | string |
| releaseTrain | ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'. | string |
| scope | Scope at which the extension is installed. | Scope |
| statuses | Status from this extension. | ExtensionStatus[] |
| version | User-specified version of the extension for this extension to 'pin'. To use 'version', autoUpgradeMinorVersion must be 'false'. | string |
ExtensionPropertiesAksAssignedIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | "SystemAssigned" "UserAssigned" |
Scope
| Name | Description | Value |
|---|---|---|
| cluster | Specifies that the scope of the extension is Cluster | ScopeCluster |
| namespace | Specifies that the scope of the extension is Namespace | ScopeNamespace |
ScopeCluster
| Name | Description | Value |
|---|---|---|
| releaseNamespace | Namespace where the extension Release must be placed, for a Cluster scoped extension. If this namespace does not exist, it will be created | string |
ScopeNamespace
| Name | Description | Value |
|---|---|---|
| targetNamespace | Namespace where the extension will be created for an Namespace scoped extension. If this namespace does not exist, it will be created | string |
ExtensionStatus
| Name | Description | Value |
|---|---|---|
| code | Status code provided by the Extension | string |
| displayStatus | Short description of status of the extension. | string |
| level | Level of the status. | "Error" "Information" "Warning" |
| message | Detailed message of the status from the Extension. | string |
| time | DateLiteral (per ISO8601) noting the time of installation status. | string |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for