Microsoft.KubernetesConfiguration extensions 2020-07-01-preview
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@2020-07-01-preview' = {
name: 'string'
scope: resourceSymbolicName
properties: {
autoUpgradeMinorVersion: bool
configurationProtectedSettings: {}
configurationSettings: {}
extensionType: 'string'
identity: {
type: 'string'
}
releaseTrain: 'string'
scope: {
cluster: {
releaseNamespace: 'string'
}
namespace: {
targetNamespace: 'string'
}
}
statuses: [
{
code: 'string'
displayStatus: 'string'
level: 'string'
message: 'string'
time: 'string'
}
]
version: 'string'
}
systemData: {}
}
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. |
| properties | Properties of an Extension Instance resource | ExtensionInstanceProperties |
| systemData | Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources |
SystemData |
ExtensionInstanceProperties
| Name | Description | Value |
|---|---|---|
| autoUpgradeMinorVersion | Flag to note if this instance participates in auto upgrade of minor version, or not. | bool |
| configurationProtectedSettings | Configuration settings that are sensitive, as name-value pairs for configuring this instance of the extension. | object |
| configurationSettings | Configuration settings, as name-value pairs for configuring this instance of the 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 |
| identity | The identity of the configuration. | ConfigurationIdentity |
| releaseTrain | ReleaseTrain this extension instance participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'. | string |
| scope | Scope at which the extension instance is installed. | Scope |
| statuses | Status from this instance of the extension. | ExtensionStatus[] |
| version | Version of the extension for this extension instance, if it is 'pinned' to a specific version. autoUpgradeMinorVersion must be 'false'. | string |
ConfigurationIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of identity used for the configuration. Type 'SystemAssigned' will use an implicitly created identity. Type 'None' will not use Managed Identity for the configuration. | 'None' 'SystemAssigned' |
Scope
| Name | Description | Value |
|---|---|---|
| cluster | Specifies that the scope of the extensionInstance is Cluster | ScopeCluster |
| namespace | Specifies that the scope of the extensionInstance is Namespace | ScopeNamespace |
ScopeCluster
| Name | Description | Value |
|---|---|---|
| releaseNamespace | Namespace where the extension Release must be placed, for a Cluster scoped extensionInstance. If this namespace does not exist, it will be created | string |
ScopeNamespace
| Name | Description | Value |
|---|---|---|
| targetNamespace | Namespace where the extensionInstance will be created for an Namespace scoped extensionInstance. 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 this instance of the extension. | string |
| level | Level of the status. | 'Error' 'Information' 'Warning' |
| message | Detailed message of the status from the Extension instance. | string |
| time | DateLiteral (per ISO8601) noting the time of installation status. | string |
SystemData
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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": "2020-07-01-preview",
"name": "string",
"scope": "string",
"properties": {
"autoUpgradeMinorVersion": "bool",
"configurationProtectedSettings": {},
"configurationSettings": {},
"extensionType": "string",
"identity": {
"type": "string"
},
"releaseTrain": "string",
"scope": {
"cluster": {
"releaseNamespace": "string"
},
"namespace": {
"targetNamespace": "string"
}
},
"statuses": [
{
"code": "string",
"displayStatus": "string",
"level": "string",
"message": "string",
"time": "string"
}
],
"version": "string"
},
"systemData": {}
}
Property values
extensions
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.KubernetesConfiguration/extensions' |
| apiVersion | The resource api version | '2020-07-01-preview' |
| 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. |
| properties | Properties of an Extension Instance resource | ExtensionInstanceProperties |
| systemData | Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources |
SystemData |
ExtensionInstanceProperties
| Name | Description | Value |
|---|---|---|
| autoUpgradeMinorVersion | Flag to note if this instance participates in auto upgrade of minor version, or not. | bool |
| configurationProtectedSettings | Configuration settings that are sensitive, as name-value pairs for configuring this instance of the extension. | object |
| configurationSettings | Configuration settings, as name-value pairs for configuring this instance of the 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 |
| identity | The identity of the configuration. | ConfigurationIdentity |
| releaseTrain | ReleaseTrain this extension instance participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'. | string |
| scope | Scope at which the extension instance is installed. | Scope |
| statuses | Status from this instance of the extension. | ExtensionStatus[] |
| version | Version of the extension for this extension instance, if it is 'pinned' to a specific version. autoUpgradeMinorVersion must be 'false'. | string |
ConfigurationIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of identity used for the configuration. Type 'SystemAssigned' will use an implicitly created identity. Type 'None' will not use Managed Identity for the configuration. | 'None' 'SystemAssigned' |
Scope
| Name | Description | Value |
|---|---|---|
| cluster | Specifies that the scope of the extensionInstance is Cluster | ScopeCluster |
| namespace | Specifies that the scope of the extensionInstance is Namespace | ScopeNamespace |
ScopeCluster
| Name | Description | Value |
|---|---|---|
| releaseNamespace | Namespace where the extension Release must be placed, for a Cluster scoped extensionInstance. If this namespace does not exist, it will be created | string |
ScopeNamespace
| Name | Description | Value |
|---|---|---|
| targetNamespace | Namespace where the extensionInstance will be created for an Namespace scoped extensionInstance. 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 this instance of the extension. | string |
| level | Level of the status. | 'Error' 'Information' 'Warning' |
| message | Detailed message of the status from the Extension instance. | string |
| time | DateLiteral (per ISO8601) noting the time of installation status. | string |
SystemData
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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@2020-07-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
autoUpgradeMinorVersion = bool
configurationProtectedSettings = {}
configurationSettings = {}
extensionType = "string"
identity = {
type = "string"
}
releaseTrain = "string"
scope = {
cluster = {
releaseNamespace = "string"
}
namespace = {
targetNamespace = "string"
}
}
statuses = [
{
code = "string"
displayStatus = "string"
level = "string"
message = "string"
time = "string"
}
]
version = "string"
}
systemData = {}
})
}
Property values
extensions
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.KubernetesConfiguration/extensions@2020-07-01-preview" |
| name | The resource name | string (required) |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| properties | Properties of an Extension Instance resource | ExtensionInstanceProperties |
| systemData | Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources |
SystemData |
ExtensionInstanceProperties
| Name | Description | Value |
|---|---|---|
| autoUpgradeMinorVersion | Flag to note if this instance participates in auto upgrade of minor version, or not. | bool |
| configurationProtectedSettings | Configuration settings that are sensitive, as name-value pairs for configuring this instance of the extension. | object |
| configurationSettings | Configuration settings, as name-value pairs for configuring this instance of the 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 |
| identity | The identity of the configuration. | ConfigurationIdentity |
| releaseTrain | ReleaseTrain this extension instance participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'. | string |
| scope | Scope at which the extension instance is installed. | Scope |
| statuses | Status from this instance of the extension. | ExtensionStatus[] |
| version | Version of the extension for this extension instance, if it is 'pinned' to a specific version. autoUpgradeMinorVersion must be 'false'. | string |
ConfigurationIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of identity used for the configuration. Type 'SystemAssigned' will use an implicitly created identity. Type 'None' will not use Managed Identity for the configuration. | "None" "SystemAssigned" |
Scope
| Name | Description | Value |
|---|---|---|
| cluster | Specifies that the scope of the extensionInstance is Cluster | ScopeCluster |
| namespace | Specifies that the scope of the extensionInstance is Namespace | ScopeNamespace |
ScopeCluster
| Name | Description | Value |
|---|---|---|
| releaseNamespace | Namespace where the extension Release must be placed, for a Cluster scoped extensionInstance. If this namespace does not exist, it will be created | string |
ScopeNamespace
| Name | Description | Value |
|---|---|---|
| targetNamespace | Namespace where the extensionInstance will be created for an Namespace scoped extensionInstance. 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 this instance of the extension. | string |
| level | Level of the status. | "Error" "Information" "Warning" |
| message | Detailed message of the status from the Extension instance. | string |
| time | DateLiteral (per ISO8601) noting the time of installation status. | string |
SystemData
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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