extensions

Creates, updates, deletes, gets or lists an extensions resource.

Overview

Name	extensions
Type	Resource
Id	azure.kubernetes_configuration.extensions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalDetails	object	Additional details provided by the publisher of the extension.
aksAssignedIdentity	object	Identity of the Extension resource in an AKS cluster.
autoUpgradeMinorVersion	boolean	Flag to note if this extension participates in auto upgrade of minor version, or not.
autoUpgradeMode	string	The upgrade mode for auto upgrade. The default is "compatible". Known values are: "none", "patch", and "compatible". (none, patch, compatible)
configurationProtectedSettings	object	Configuration settings that are sensitive, as name-value pairs for configuring this extension.
configurationSettings	object	Configuration settings, as name-value pairs for configuring this extension.
currentVersion	string	Currently installed version of the extension.
customLocationSettings	object	Custom Location settings properties.
errorInfo	object	Error information from the Agent - e.g. errors during installation.
extensionState	string	State of the extension on the cluster.
extensionType	string	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.
identity	object	Identity of the Extension resource.
isSystemExtension	boolean	Flag to note if this extension is a system extension.
managedBy	string	The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
managementDetails	object	Management details of the extension.
packageUri	string	Uri of the Helm package.
plan	object	Details of the resource plan.
provisioningState	string	Status of installation of this extension. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
releaseTrain	string	ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'.
scope	object	Scope at which the extension is installed.
statuses	array	Status from this extension.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	User-specified version of the extension for this extension to 'pin'. To use 'version', autoUpgradeMinorVersion must be 'false'.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
aksAssignedIdentity	object	Identity of the Extension resource in an AKS cluster.
autoUpgradeMinorVersion	boolean	Flag to note if this extension participates in auto upgrade of minor version, or not.
configurationProtectedSettings	object	Configuration settings that are sensitive, as name-value pairs for configuring this extension.
configurationSettings	object	Configuration settings, as name-value pairs for configuring this extension.
currentVersion	string	Currently installed version of the extension.
customLocationSettings	object	Custom Location settings properties.
errorInfo	object	Error information from the Agent - e.g. errors during installation.
extensionType	string	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.
identity	object	Identity of the Extension resource.
isSystemExtension	boolean	Flag to note if this extension is a system extension.
packageUri	string	Uri of the Helm package.
plan	object	The plan information.
provisioningState	string	Status of installation of this extension. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting".
releaseTrain	string	ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'.
scope	object	Scope at which the extension is installed.
statuses	array	Status from this extension.
systemData	object	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.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	User-specified version of the extension for this extension to 'pin'. To use 'version', autoUpgradeMinorVersion must be 'false'.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_rp, cluster_resource_name, cluster_name, extension_name, subscription_id		Gets Kubernetes Cluster Extension.
list	select	resource_group_name, cluster_rp, cluster_resource_name, cluster_name, subscription_id		List all Extensions in the cluster.
create	insert	resource_group_name, cluster_rp, cluster_resource_name, cluster_name, extension_name, subscription_id		Create a new Kubernetes Cluster Extension.
update	update	resource_group_name, cluster_rp, cluster_resource_name, cluster_name, extension_name, subscription_id		Patch an existing Kubernetes Cluster Extension.
delete	delete	resource_group_name, cluster_rp, cluster_resource_name, cluster_name, extension_name, subscription_id	forceDelete	Delete a Kubernetes Cluster Extension. This will cause the Agent to Uninstall the extension from the cluster.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cluster_name	string	The name of the kubernetes cluster. Required.
cluster_resource_name	string	The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters, appliances. Required.
cluster_rp	string	The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService. Required.
extension_name	string	Name of the Extension. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
forceDelete	boolean	Delete the extension resource in Azure - not the normal asynchronous delete. Default value is None.

SELECT examples

get

Gets Kubernetes Cluster Extension.

SELECT
id,
name,
additionalDetails,
aksAssignedIdentity,
autoUpgradeMinorVersion,
autoUpgradeMode,
configurationProtectedSettings,
configurationSettings,
currentVersion,
customLocationSettings,
errorInfo,
extensionState,
extensionType,
identity,
isSystemExtension,
managedBy,
managementDetails,
packageUri,
plan,
provisioningState,
releaseTrain,
scope,
statuses,
systemData,
type,
version
FROM azure.kubernetes_configuration.extensions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_rp = '{{ cluster_rp }}' -- required
AND cluster_resource_name = '{{ cluster_resource_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND extension_name = '{{ extension_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all Extensions in the cluster.

SELECT
id,
name,
aksAssignedIdentity,
autoUpgradeMinorVersion,
configurationProtectedSettings,
configurationSettings,
currentVersion,
customLocationSettings,
errorInfo,
extensionType,
identity,
isSystemExtension,
packageUri,
plan,
provisioningState,
releaseTrain,
scope,
statuses,
systemData,
type,
version
FROM azure.kubernetes_configuration.extensions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_rp = '{{ cluster_rp }}' -- required
AND cluster_resource_name = '{{ cluster_resource_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a new Kubernetes Cluster Extension.

INSERT INTO azure.kubernetes_configuration.extensions (
properties,
identity,
managedBy,
plan,
resource_group_name,
cluster_rp,
cluster_resource_name,
cluster_name,
extension_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ managedBy }}',
'{{ plan }}',
'{{ resource_group_name }}',
'{{ cluster_rp }}',
'{{ cluster_resource_name }}',
'{{ cluster_name }}',
'{{ extension_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
managedBy,
plan,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: extensions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the extensions resource.
  - name: cluster_rp
    value: "{{ cluster_rp }}"
    description: Required parameter for the extensions resource.
  - name: cluster_resource_name
    value: "{{ cluster_resource_name }}"
    description: Required parameter for the extensions resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the extensions resource.
  - name: extension_name
    value: "{{ extension_name }}"
    description: Required parameter for the extensions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the extensions resource.
  - name: properties
    description: |
      Properties of an Extension resource.
    value:
      extensionType: "{{ extensionType }}"
      autoUpgradeMinorVersion: {{ autoUpgradeMinorVersion }}
      releaseTrain: "{{ releaseTrain }}"
      version: "{{ version }}"
      scope:
        cluster:
          releaseNamespace: "{{ releaseNamespace }}"
        namespace:
          targetNamespace: "{{ targetNamespace }}"
      configurationSettings: "{{ configurationSettings }}"
      configurationProtectedSettings: "{{ configurationProtectedSettings }}"
      currentVersion: "{{ currentVersion }}"
      provisioningState: "{{ provisioningState }}"
      statuses:
        - code: "{{ code }}"
          displayStatus: "{{ displayStatus }}"
          level: "{{ level }}"
          message: "{{ message }}"
          time: "{{ time }}"
      errorInfo:
        code: "{{ code }}"
        message: "{{ message }}"
        target: "{{ target }}"
        details:
          - code: "{{ code }}"
            message: "{{ message }}"
            target: "{{ target }}"
            details: "{{ details }}"
            additionalInfo: "{{ additionalInfo }}"
        additionalInfo:
          - type: "{{ type }}"
            info: "{{ info }}"
      customLocationSettings: "{{ customLocationSettings }}"
      packageUri: "{{ packageUri }}"
      aksAssignedIdentity:
        principalId: "{{ principalId }}"
        tenantId: "{{ tenantId }}"
        type: "{{ type }}"
        objectId: "{{ objectId }}"
        clientId: "{{ clientId }}"
        resourceId: "{{ resourceId }}"
      isSystemExtension: {{ isSystemExtension }}
      autoUpgradeMode: "{{ autoUpgradeMode }}"
      managementDetails:
        category: "{{ category }}"
        accessDetails:
          - entity: "{{ entity }}"
            allowedActions: "{{ allowedActions }}"
            description: "{{ description }}"
      additionalDetails:
        docs: "{{ docs }}"
        releaseNotes: "{{ releaseNotes }}"
        troubleshootingGuide: "{{ troubleshootingGuide }}"
      extensionState: "{{ extensionState }}"
  - name: identity
    description: |
      Identity of the Extension resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
  - name: managedBy
    value: "{{ managedBy }}"
    description: |
      The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
  - name: plan
    description: |
      Details of the resource plan.
    value:
      name: "{{ name }}"
      publisher: "{{ publisher }}"
      product: "{{ product }}"
      promotionCode: "{{ promotionCode }}"
      version: "{{ version }}"

UPDATE examples

update

Patch an existing Kubernetes Cluster Extension.

UPDATE azure.kubernetes_configuration.extensions
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_rp = '{{ cluster_rp }}' --required
AND cluster_resource_name = '{{ cluster_resource_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND extension_name = '{{ extension_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
managedBy,
plan,
properties,
systemData,
type;

DELETE examples

delete

Delete a Kubernetes Cluster Extension. This will cause the Agent to Uninstall the extension from the cluster.

DELETE FROM azure.kubernetes_configuration.extensions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_rp = '{{ cluster_rp }}' --required
AND cluster_resource_name = '{{ cluster_resource_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND extension_name = '{{ extension_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND forceDelete = '{{ forceDelete }}'
;