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
identity	object	Identity of the Extension resource
plan	object	The plan information.
properties	object	Properties of an Extension resource
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

list

Name	Datatype	Description
identity	object	Identity of the Extension resource
plan	object	The plan information.
properties	object	Properties of an Extension resource
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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterRp, clusterResourceName, clusterName, extensionName		Gets Kubernetes Cluster Extension.
list	select	subscriptionId, resourceGroupName, clusterRp, clusterResourceName, clusterName		List all Extensions in the cluster.
create	insert	subscriptionId, resourceGroupName, clusterRp, clusterResourceName, clusterName, extensionName		Create a new Kubernetes Cluster Extension.
update	update	subscriptionId, resourceGroupName, clusterRp, clusterResourceName, clusterName, extensionName		Patch an existing Kubernetes Cluster Extension.
delete	delete	subscriptionId, resourceGroupName, clusterRp, clusterResourceName, clusterName, extensionName	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
clusterName	string	The name of the kubernetes cluster.
clusterResourceName	string	The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.
clusterRp	string	The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.
extensionName	string	Name of the Extension.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
forceDelete	boolean	Delete the extension resource in Azure - not the normal asynchronous delete.

SELECT examples

get

Gets Kubernetes Cluster Extension.

SELECT
identity,
plan,
properties,
systemData
FROM azure.kubernetes_configuration.extensions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterRp = '{{ clusterRp }}' -- required
AND clusterResourceName = '{{ clusterResourceName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND extensionName = '{{ extensionName }}' -- required
;

list

List all Extensions in the cluster.

SELECT
identity,
plan,
properties,
systemData
FROM azure.kubernetes_configuration.extensions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterRp = '{{ clusterRp }}' -- required
AND clusterResourceName = '{{ clusterResourceName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;

INSERT examples

create

Create a new Kubernetes Cluster Extension.

INSERT INTO azure.kubernetes_configuration.extensions (
data__properties,
data__identity,
data__plan,
subscriptionId,
resourceGroupName,
clusterRp,
clusterResourceName,
clusterName,
extensionName
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ plan }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterRp }}',
'{{ clusterResourceName }}',
'{{ clusterName }}',
'{{ extensionName }}'
RETURNING
identity,
plan,
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: extensions
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the extensions resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the extensions resource.
    - name: clusterRp
      value: string
      description: Required parameter for the extensions resource.
    - name: clusterResourceName
      value: string
      description: Required parameter for the extensions resource.
    - name: clusterName
      value: string
      description: Required parameter for the extensions resource.
    - name: extensionName
      value: string
      description: Required parameter for the extensions resource.
    - name: properties
      value: object
      description: |
        Properties of an Extension resource
    - name: identity
      value: object
      description: |
        Identity of the Extension resource
    - name: plan
      value: object
      description: |
        The plan information.

UPDATE examples

update

Patch an existing Kubernetes Cluster Extension.

UPDATE azure.kubernetes_configuration.extensions
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterRp = '{{ clusterRp }}' --required
AND clusterResourceName = '{{ clusterResourceName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND extensionName = '{{ extensionName }}' --required
RETURNING
identity,
plan,
properties,
systemData;

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 subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterRp = '{{ clusterRp }}' --required
AND clusterResourceName = '{{ clusterResourceName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND extensionName = '{{ extensionName }}' --required
AND forceDelete = '{{ forceDelete }}'
;