extension_types

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

Overview

Name	extension_types
Type	Resource
Id	azure.kubernetes_configuration.extension_types

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.
description	string	Description of the extension type.
isManagedIdentityRequired	boolean	Should an identity for this cluster resource be created.
isSystemExtension	boolean	Is this Extension Type a system extension.
planInfo	object	Plan information only for the Marketplace Extension Type.
publisher	string	Name of the publisher for the Extension Type.
supportedClusterTypes	array	Cluster Types supported for this Extension Type.
supportedScopes	object	Supported Kubernetes Scopes for this Extension Type.
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".

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.
description	string	Description of the extension type.
isManagedIdentityRequired	boolean	Should an identity for this cluster resource be created.
isSystemExtension	boolean	Is this Extension Type a system extension.
planInfo	object	Plan information only for the Marketplace Extension Type.
publisher	string	Name of the publisher for the Extension Type.
supportedClusterTypes	array	Cluster Types supported for this Extension Type.
supportedScopes	object	Supported Kubernetes Scopes for this Extension Type.
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".

get_version

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.
supportedClusterTypes	array	A list of supported cluster types for this version of the Extension Type.
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".
unsupportedKubernetesVersions	object	The list of supported Kubernetes cluster versions for this extension type.
version	string	The version number for the extension type.

list_versions

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.
supportedClusterTypes	array	A list of supported cluster types for this version of the Extension Type.
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".
unsupportedKubernetesVersions	object	The list of supported Kubernetes cluster versions for this extension type.
version	string	The version number for the extension type.

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_type_name, subscription_id		Get an Extension Type installable to the cluster based region and type for the cluster.
list	select	resource_group_name, cluster_rp, cluster_resource_name, cluster_name, subscription_id	publisherId, offerId, planId, releaseTrain	List installable Extension Types for the cluster based region and type for the cluster.
get_version	select	location, extension_type_name, version_number, subscription_id		Get details of a version for an extension type and location.
list_versions	select	location, extension_type_name, subscription_id	releaseTrain, clusterType, majorVersion, showLatest	List the versions for an extension type and location.
location_get	exec	location, extension_type_name, subscription_id		Get an extension type for the location.
location_list	exec	location, subscription_id	publisherId, offerId, planId, releaseTrain, clusterType	List all Extension Types for the location.
cluster_get_version	exec	resource_group_name, cluster_rp, cluster_resource_name, cluster_name, extension_type_name, version_number, subscription_id		Get details of a version for an Extension Type installable to the cluster.
cluster_list_versions	exec	resource_group_name, cluster_rp, cluster_resource_name, cluster_name, extension_type_name, subscription_id	releaseTrain, majorVersion, showLatest	List the version for an Extension Type installable to 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_type_name	string	Name of the Extension Type. Required.
location	string	The location name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
version_number	string	Version number of the Extension Type. Required.
clusterType	string	Filter results by the cluster type for extension types. Default value is None.
majorVersion	string	Filter results by the major version of an extension type. Default value is None.
offerId	string	Filter results by Offer or Product ID of a marketplace extension type. Default value is None.
planId	string	Filter results by Plan ID of a marketplace extension type. Default value is None.
publisherId	string	Filter results by Publisher ID of a marketplace extension type. Default value is None.
releaseTrain	string	Filter results by release train (default value is stable). Default value is None.
showLatest	boolean	Filter results by only the latest version (based on other query parameters). Default value is None.

SELECT examples

get

Get an Extension Type installable to the cluster based region and type for the cluster.

SELECT
id,
name,
description,
isManagedIdentityRequired,
isSystemExtension,
planInfo,
publisher,
supportedClusterTypes,
supportedScopes,
systemData,
type
FROM azure.kubernetes_configuration.extension_types
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_type_name = '{{ extension_type_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List installable Extension Types for the cluster based region and type for the cluster.

SELECT
id,
name,
description,
isManagedIdentityRequired,
isSystemExtension,
planInfo,
publisher,
supportedClusterTypes,
supportedScopes,
systemData,
type
FROM azure.kubernetes_configuration.extension_types
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
AND publisherId = '{{ publisherId }}'
AND offerId = '{{ offerId }}'
AND planId = '{{ planId }}'
AND releaseTrain = '{{ releaseTrain }}'
;

get_version

Get details of a version for an extension type and location.

SELECT
id,
name,
supportedClusterTypes,
systemData,
type,
unsupportedKubernetesVersions,
version
FROM azure.kubernetes_configuration.extension_types
WHERE location = '{{ location }}' -- required
AND extension_type_name = '{{ extension_type_name }}' -- required
AND version_number = '{{ version_number }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_versions

List the versions for an extension type and location.

SELECT
id,
name,
supportedClusterTypes,
systemData,
type,
unsupportedKubernetesVersions,
version
FROM azure.kubernetes_configuration.extension_types
WHERE location = '{{ location }}' -- required
AND extension_type_name = '{{ extension_type_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND releaseTrain = '{{ releaseTrain }}'
AND clusterType = '{{ clusterType }}'
AND majorVersion = '{{ majorVersion }}'
AND showLatest = '{{ showLatest }}'
;

Lifecycle Methods

location_get

Get an extension type for the location.

EXEC azure.kubernetes_configuration.extension_types.location_get 
@location='{{ location }}' --required, 
@extension_type_name='{{ extension_type_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

location_list

List all Extension Types for the location.

EXEC azure.kubernetes_configuration.extension_types.location_list 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@publisherId='{{ publisherId }}', 
@offerId='{{ offerId }}', 
@planId='{{ planId }}', 
@releaseTrain='{{ releaseTrain }}', 
@clusterType='{{ clusterType }}'
;

cluster_get_version

Get details of a version for an Extension Type installable to the cluster.

EXEC azure.kubernetes_configuration.extension_types.cluster_get_version 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_rp='{{ cluster_rp }}' --required, 
@cluster_resource_name='{{ cluster_resource_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@extension_type_name='{{ extension_type_name }}' --required, 
@version_number='{{ version_number }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

cluster_list_versions

List the version for an Extension Type installable to the cluster.

EXEC azure.kubernetes_configuration.extension_types.cluster_list_versions 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_rp='{{ cluster_rp }}' --required, 
@cluster_resource_name='{{ cluster_resource_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@extension_type_name='{{ extension_type_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@releaseTrain='{{ releaseTrain }}', 
@majorVersion='{{ majorVersion }}', 
@showLatest={{ showLatest }}
;