Extensions - Create

Reference

Service:: Kubernetes Configuration

API Version:: 2023-05-01

Create a new Kubernetes Cluster Extension.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/extensions/{extensionName}?api-version=2023-05-01

URI Parameters

Name	In	Required	Type	Description
clusterName	path	True	string	The name of the kubernetes cluster.
clusterResourceName	path	True	string	The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.
clusterRp	path	True	string	The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.
extensionName	path	True	string	Name of the Extension.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Type	Description
identity	Identity	Identity of the Extension resource
plan	Plan	The plan information.
properties.aksAssignedIdentity	AksAssignedIdentity	Identity of the Extension resource in an AKS cluster
properties.autoUpgradeMinorVersion	boolean	Flag to note if this extension participates in auto upgrade of minor version, or not.
properties.configurationProtectedSettings	object	Configuration settings that are sensitive, as name-value pairs for configuring this extension.
properties.configurationSettings	object	Configuration settings, as name-value pairs for configuring this extension.
properties.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.
properties.releaseTrain	string	ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'.
properties.scope	Scope	Scope at which the extension is installed.
properties.statuses	ExtensionStatus[]	Status from this extension.
properties.version	string	User-specified version of the extension for this extension to 'pin'. To use 'version', autoUpgradeMinorVersion must be 'false'.

Responses

Name	Type	Description
200 OK	Extension	Request received successfully for an existing resource.
201 Created	Extension	Request received successfully.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create Extension

Create Extension with Plan

Create Extension

Sample request

PUT https://management.azure.com/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor?api-version=2023-05-01

{
  "properties": {
    "extensionType": "azuremonitor-containers",
    "autoUpgradeMinorVersion": true,
    "releaseTrain": "Preview",
    "scope": {
      "cluster": {
        "releaseNamespace": "kube-system"
      }
    },
    "configurationSettings": {
      "omsagent.secret.wsid": "fakeTokenPlaceholder",
      "omsagent.env.clusterName": "clusterName1"
    },
    "configurationProtectedSettings": {
      "omsagent.secret.key": "secretKeyValue01"
    }
  }
}

import com.azure.resourcemanager.kubernetesconfiguration.fluent.models.ExtensionInner;
import com.azure.resourcemanager.kubernetesconfiguration.models.Scope;
import com.azure.resourcemanager.kubernetesconfiguration.models.ScopeCluster;
import java.util.HashMap;
import java.util.Map;

/** Samples for Extensions Create. */
public final class Main {
    /*
     * x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/stable/2023-05-01/examples/CreateExtension.json
     */
    /**
     * Sample code: Create Extension.
     *
     * @param manager Entry point to SourceControlConfigurationManager.
     */
    public static void createExtension(
        com.azure.resourcemanager.kubernetesconfiguration.SourceControlConfigurationManager manager) {
        manager
            .extensions()
            .create(
                "rg1",
                "Microsoft.Kubernetes",
                "connectedClusters",
                "clusterName1",
                "ClusterMonitor",
                new ExtensionInner()
                    .withExtensionType("azuremonitor-containers")
                    .withAutoUpgradeMinorVersion(true)
                    .withReleaseTrain("Preview")
                    .withScope(new Scope().withCluster(new ScopeCluster().withReleaseNamespace("kube-system")))
                    .withConfigurationSettings(
                        mapOf(
                            "omsagent.env.clusterName", "clusterName1", "omsagent.secret.wsid", "fakeTokenPlaceholder"))
                    .withConfigurationProtectedSettings(mapOf("omsagent.secret.key", "fakeTokenPlaceholder")),
                com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.kubernetesconfiguration import SourceControlConfigurationClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-kubernetesconfiguration
# USAGE
    python create_extension.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SourceControlConfigurationClient(
        credential=DefaultAzureCredential(),
        subscription_id="subId1",
    )

    response = client.extensions.begin_create(
        resource_group_name="rg1",
        cluster_rp="Microsoft.Kubernetes",
        cluster_resource_name="connectedClusters",
        cluster_name="clusterName1",
        extension_name="ClusterMonitor",
        extension={
            "properties": {
                "autoUpgradeMinorVersion": True,
                "configurationProtectedSettings": {"omsagent.secret.key": "secretKeyValue01"},
                "configurationSettings": {
                    "omsagent.env.clusterName": "clusterName1",
                    "omsagent.secret.wsid": "a38cef99-5a89-52ed-b6db-22095c23664b",
                },
                "extensionType": "azuremonitor-containers",
                "releaseTrain": "Preview",
                "scope": {"cluster": {"releaseNamespace": "kube-system"}},
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/stable/2023-05-01/examples/CreateExtension.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armkubernetesconfiguration_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/80c21c17b4a7aa57f637ee594f7cfd653255a7e0/specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/stable/2023-05-01/examples/CreateExtension.json
func ExampleExtensionsClient_BeginCreate_createExtension() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armkubernetesconfiguration.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewExtensionsClient().BeginCreate(ctx, "rg1", "Microsoft.Kubernetes", "connectedClusters", "clusterName1", "ClusterMonitor", armkubernetesconfiguration.Extension{
		Properties: &armkubernetesconfiguration.ExtensionProperties{
			AutoUpgradeMinorVersion: to.Ptr(true),
			ConfigurationProtectedSettings: map[string]*string{
				"omsagent.secret.key": to.Ptr("secretKeyValue01"),
			},
			ConfigurationSettings: map[string]*string{
				"omsagent.env.clusterName": to.Ptr("clusterName1"),
				"omsagent.secret.wsid":     to.Ptr("a38cef99-5a89-52ed-b6db-22095c23664b"),
			},
			ExtensionType: to.Ptr("azuremonitor-containers"),
			ReleaseTrain:  to.Ptr("Preview"),
			Scope: &armkubernetesconfiguration.Scope{
				Cluster: &armkubernetesconfiguration.ScopeCluster{
					ReleaseNamespace: to.Ptr("kube-system"),
				},
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Extension = armkubernetesconfiguration.Extension{
	// 	Name: to.Ptr("ClusterMonitor"),
	// 	Type: to.Ptr("Microsoft.KubernetesConfiguration/extensions"),
	// 	ID: to.Ptr("/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor"),
	// 	Properties: &armkubernetesconfiguration.ExtensionProperties{
	// 		AutoUpgradeMinorVersion: to.Ptr(false),
	// 		ConfigurationSettings: map[string]*string{
	// 			"omsagent.env.clusterName": to.Ptr("clusterName1"),
	// 			"omsagent.secret.wsid": to.Ptr("a38cef99-5a89-52ed-b6db-22095c23664b"),
	// 		},
	// 		CurrentVersion: to.Ptr("0.1.4"),
	// 		ExtensionType: to.Ptr("azuremonitor-containers"),
	// 		IsSystemExtension: to.Ptr(false),
	// 		ProvisioningState: to.Ptr(armkubernetesconfiguration.ProvisioningStateSucceeded),
	// 		ReleaseTrain: to.Ptr("Preview"),
	// 		Scope: &armkubernetesconfiguration.Scope{
	// 			Cluster: &armkubernetesconfiguration.ScopeCluster{
	// 				ReleaseNamespace: to.Ptr("kube-system"),
	// 			},
	// 		},
	// 		Statuses: []*armkubernetesconfiguration.ExtensionStatus{
	// 		},
	// 		Version: to.Ptr("0.1.4"),
	// 	},
	// 	SystemData: &armkubernetesconfiguration.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-09-08T05:10:57.027Z"); return t}()),
	// 		CreatedBy: to.Ptr("string"),
	// 		CreatedByType: to.Ptr(armkubernetesconfiguration.CreatedByTypeApplication),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-09-08T05:10:57.027Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("string"),
	// 		LastModifiedByType: to.Ptr(armkubernetesconfiguration.CreatedByTypeApplication),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SourceControlConfigurationClient } = require("@azure/arm-kubernetesconfiguration");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create a new Kubernetes Cluster Extension.
 *
 * @summary Create a new Kubernetes Cluster Extension.
 * x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/stable/2023-05-01/examples/CreateExtension.json
 */
async function createExtension() {
  const subscriptionId = process.env["KUBERNETESCONFIGURATION_SUBSCRIPTION_ID"] || "subId1";
  const resourceGroupName = process.env["KUBERNETESCONFIGURATION_RESOURCE_GROUP"] || "rg1";
  const clusterRp = "Microsoft.Kubernetes";
  const clusterResourceName = "connectedClusters";
  const clusterName = "clusterName1";
  const extensionName = "ClusterMonitor";
  const extension = {
    autoUpgradeMinorVersion: true,
    configurationProtectedSettings: { omsagentSecretKey: "secretKeyValue01" },
    configurationSettings: {
      omsagentEnvClusterName: "clusterName1",
      omsagentSecretWsid: "a38cef99-5a89-52ed-b6db-22095c23664b",
    },
    extensionType: "azuremonitor-containers",
    releaseTrain: "Preview",
    scope: { cluster: { releaseNamespace: "kube-system" } },
  };
  const credential = new DefaultAzureCredential();
  const client = new SourceControlConfigurationClient(credential, subscriptionId);
  const result = await client.extensions.beginCreateAndWait(
    resourceGroupName,
    clusterRp,
    clusterResourceName,
    clusterName,
    extensionName,
    extension
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 201

Operation-Location: /subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor/operations/{operationId}
x-ms-async-operation-timeout: PT48H
Azure-AsyncOperation: http://management.azure.com/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Kubernetes/ConnectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor/operations/operationId?api-version=2023-05-01

{
  "id": "/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor",
  "type": "Microsoft.KubernetesConfiguration/extensions",
  "name": "ClusterMonitor",
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2021-09-08T05:10:57.027Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2021-09-08T05:10:57.027Z"
  },
  "properties": {
    "extensionType": "azuremonitor-containers",
    "autoUpgradeMinorVersion": false,
    "releaseTrain": "Preview",
    "version": "0.1.4",
    "scope": {
      "cluster": {
        "releaseNamespace": "kube-system"
      }
    },
    "configurationSettings": {
      "omsagent.secret.wsid": "fakeTokenPlaceholder",
      "omsagent.env.clusterName": "clusterName1"
    },
    "provisioningState": "Creating",
    "currentVersion": null,
    "statuses": [],
    "isSystemExtension": false
  }
}

Status code:: 200

Operation-Location: /subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor/operations/{operationId}
x-ms-async-operation-timeout: PT48H

{
  "id": "/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor",
  "type": "Microsoft.KubernetesConfiguration/extensions",
  "name": "ClusterMonitor",
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2021-09-08T05:10:57.027Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2021-09-08T05:10:57.027Z"
  },
  "properties": {
    "extensionType": "azuremonitor-containers",
    "autoUpgradeMinorVersion": false,
    "releaseTrain": "Preview",
    "version": "0.1.4",
    "scope": {
      "cluster": {
        "releaseNamespace": "kube-system"
      }
    },
    "configurationSettings": {
      "omsagent.secret.wsid": "fakeTokenPlaceholder",
      "omsagent.env.clusterName": "clusterName1"
    },
    "provisioningState": "Succeeded",
    "currentVersion": "0.1.4",
    "statuses": [],
    "isSystemExtension": false
  }
}

Create Extension with Plan

Sample request

PUT https://management.azure.com/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote?api-version=2023-05-01

{
  "properties": {
    "extensionType": "azure-vote",
    "autoUpgradeMinorVersion": true,
    "releaseTrain": "Preview"
  },
  "plan": {
    "name": "azure-vote-standard",
    "publisher": "Microsoft",
    "product": "azure-vote-standard-offer-id"
  }
}

import com.azure.resourcemanager.kubernetesconfiguration.fluent.models.ExtensionInner;
import com.azure.resourcemanager.kubernetesconfiguration.models.Plan;
import java.util.HashMap;
import java.util.Map;

/** Samples for Extensions Create. */
public final class Main {
    /*
     * x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/stable/2023-05-01/examples/CreateExtensionWithPlan.json
     */
    /**
     * Sample code: Create Extension with Plan.
     *
     * @param manager Entry point to SourceControlConfigurationManager.
     */
    public static void createExtensionWithPlan(
        com.azure.resourcemanager.kubernetesconfiguration.SourceControlConfigurationManager manager) {
        manager
            .extensions()
            .create(
                "rg1",
                "Microsoft.Kubernetes",
                "connectedClusters",
                "clusterName1",
                "azureVote",
                new ExtensionInner()
                    .withPlan(
                        new Plan()
                            .withName("azure-vote-standard")
                            .withPublisher("Microsoft")
                            .withProduct("azure-vote-standard-offer-id"))
                    .withExtensionType("azure-vote")
                    .withAutoUpgradeMinorVersion(true)
                    .withReleaseTrain("Preview"),
                com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.kubernetesconfiguration import SourceControlConfigurationClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-kubernetesconfiguration
# USAGE
    python create_extension_with_plan.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SourceControlConfigurationClient(
        credential=DefaultAzureCredential(),
        subscription_id="subId1",
    )

    response = client.extensions.begin_create(
        resource_group_name="rg1",
        cluster_rp="Microsoft.Kubernetes",
        cluster_resource_name="connectedClusters",
        cluster_name="clusterName1",
        extension_name="azureVote",
        extension={
            "plan": {
                "name": "azure-vote-standard",
                "product": "azure-vote-standard-offer-id",
                "publisher": "Microsoft",
            },
            "properties": {"autoUpgradeMinorVersion": True, "extensionType": "azure-vote", "releaseTrain": "Preview"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/stable/2023-05-01/examples/CreateExtensionWithPlan.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armkubernetesconfiguration_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/80c21c17b4a7aa57f637ee594f7cfd653255a7e0/specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/stable/2023-05-01/examples/CreateExtensionWithPlan.json
func ExampleExtensionsClient_BeginCreate_createExtensionWithPlan() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armkubernetesconfiguration.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewExtensionsClient().BeginCreate(ctx, "rg1", "Microsoft.Kubernetes", "connectedClusters", "clusterName1", "azureVote", armkubernetesconfiguration.Extension{
		Plan: &armkubernetesconfiguration.Plan{
			Name:      to.Ptr("azure-vote-standard"),
			Product:   to.Ptr("azure-vote-standard-offer-id"),
			Publisher: to.Ptr("Microsoft"),
		},
		Properties: &armkubernetesconfiguration.ExtensionProperties{
			AutoUpgradeMinorVersion: to.Ptr(true),
			ExtensionType:           to.Ptr("azure-vote"),
			ReleaseTrain:            to.Ptr("Preview"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Extension = armkubernetesconfiguration.Extension{
	// 	Name: to.Ptr("azureVote"),
	// 	Type: to.Ptr("Microsoft.KubernetesConfiguration/extensions"),
	// 	ID: to.Ptr("/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote"),
	// 	Plan: &armkubernetesconfiguration.Plan{
	// 		Name: to.Ptr("azure-vote-standard"),
	// 		Product: to.Ptr("azure-vote-standard-offer-id"),
	// 		Publisher: to.Ptr("Microsoft"),
	// 	},
	// 	Properties: &armkubernetesconfiguration.ExtensionProperties{
	// 		AutoUpgradeMinorVersion: to.Ptr(true),
	// 		CurrentVersion: to.Ptr("0.1.4"),
	// 		ExtensionType: to.Ptr("azure-vote"),
	// 		IsSystemExtension: to.Ptr(false),
	// 		ProvisioningState: to.Ptr(armkubernetesconfiguration.ProvisioningStateSucceeded),
	// 		ReleaseTrain: to.Ptr("Preview"),
	// 		Scope: &armkubernetesconfiguration.Scope{
	// 			Cluster: &armkubernetesconfiguration.ScopeCluster{
	// 				ReleaseNamespace: to.Ptr("kube-system"),
	// 			},
	// 		},
	// 		Statuses: []*armkubernetesconfiguration.ExtensionStatus{
	// 		},
	// 		Version: to.Ptr("0.1.4"),
	// 	},
	// 	SystemData: &armkubernetesconfiguration.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-09-08T05:10:57.027Z"); return t}()),
	// 		CreatedBy: to.Ptr("string"),
	// 		CreatedByType: to.Ptr(armkubernetesconfiguration.CreatedByTypeApplication),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-09-08T05:10:57.027Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("string"),
	// 		LastModifiedByType: to.Ptr(armkubernetesconfiguration.CreatedByTypeApplication),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SourceControlConfigurationClient } = require("@azure/arm-kubernetesconfiguration");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create a new Kubernetes Cluster Extension.
 *
 * @summary Create a new Kubernetes Cluster Extension.
 * x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/stable/2023-05-01/examples/CreateExtensionWithPlan.json
 */
async function createExtensionWithPlan() {
  const subscriptionId = process.env["KUBERNETESCONFIGURATION_SUBSCRIPTION_ID"] || "subId1";
  const resourceGroupName = process.env["KUBERNETESCONFIGURATION_RESOURCE_GROUP"] || "rg1";
  const clusterRp = "Microsoft.Kubernetes";
  const clusterResourceName = "connectedClusters";
  const clusterName = "clusterName1";
  const extensionName = "azureVote";
  const extension = {
    autoUpgradeMinorVersion: true,
    extensionType: "azure-vote",
    plan: {
      name: "azure-vote-standard",
      product: "azure-vote-standard-offer-id",
      publisher: "Microsoft",
    },
    releaseTrain: "Preview",
  };
  const credential = new DefaultAzureCredential();
  const client = new SourceControlConfigurationClient(credential, subscriptionId);
  const result = await client.extensions.beginCreateAndWait(
    resourceGroupName,
    clusterRp,
    clusterResourceName,
    clusterName,
    extensionName,
    extension
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 201

Operation-Location: /subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote/operations/{operationId}
x-ms-async-operation-timeout: PT48H
Azure-AsyncOperation: http://management.azure.com/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Kubernetes/ConnectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote/operations/operationId?api-version=2022-04-01-preview

{
  "id": "/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote",
  "type": "Microsoft.KubernetesConfiguration/extensions",
  "name": "azureVote",
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2021-09-08T05:10:57.027Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2021-09-08T05:10:57.027Z"
  },
  "plan": {
    "name": "azure-vote-standard",
    "publisher": "Microsoft",
    "product": "azure-vote-standard-offer-id"
  },
  "properties": {
    "extensionType": "azure-vote",
    "autoUpgradeMinorVersion": true,
    "releaseTrain": "Preview",
    "version": "0.1.4",
    "scope": {
      "cluster": {
        "releaseNamespace": "kube-system"
      }
    },
    "provisioningState": "Creating",
    "statuses": [],
    "currentVersion": null,
    "isSystemExtension": false
  }
}

Status code:: 200

Operation-Location: /subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote/operations/{operationId}
x-ms-async-operation-timeout: PT48H

{
  "id": "/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote",
  "type": "Microsoft.KubernetesConfiguration/extensions",
  "name": "azureVote",
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2021-09-08T05:10:57.027Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2021-09-08T05:10:57.027Z"
  },
  "plan": {
    "name": "azure-vote-standard",
    "publisher": "Microsoft",
    "product": "azure-vote-standard-offer-id"
  },
  "properties": {
    "extensionType": "azure-vote",
    "autoUpgradeMinorVersion": true,
    "releaseTrain": "Preview",
    "version": "0.1.4",
    "scope": {
      "cluster": {
        "releaseNamespace": "kube-system"
      }
    },
    "provisioningState": "Creating",
    "statuses": [],
    "currentVersion": "0.1.4",
    "isSystemExtension": false
  }
}

Definitions

Name	Description
AksAssignedIdentity	Identity of the Extension resource in an AKS cluster
AKSIdentityType	The identity type.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Extension	The Extension object.
ExtensionStatus	Status from the extension.
Identity	Identity for the resource.
LevelType	Level of the status.
Plan	Plan for the resource.
ProvisioningState	Status of installation of this extension.
ResourceIdentityType	The identity type.
Scope	Scope of the extension. It can be either Cluster or Namespace; but not both.
ScopeCluster	Specifies that the scope of the extension is Cluster
ScopeNamespace	Specifies that the scope of the extension is Namespace
systemData	Metadata pertaining to creation and last modification of the resource.

AksAssignedIdentity

Identity of the Extension resource in an AKS cluster

Name	Type	Description
principalId	string	The principal ID of resource identity.
tenantId	string	The tenant ID of resource.
type	AKSIdentityType	The identity type.

AKSIdentityType

The identity type.

Name	Type	Description
SystemAssigned	string
UserAssigned	string

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Extension

The Extension object.

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

ExtensionStatus

Status from the extension.

Name	Type	Default value	Description
code	string		Status code provided by the Extension
displayStatus	string		Short description of status of the extension.
level	LevelType	Information	Level of the status.
message	string		Detailed message of the status from the Extension.
time	string		DateLiteral (per ISO8601) noting the time of installation status.

Identity

Identity for the resource.

Name	Type	Description
principalId	string	The principal ID of resource identity.
tenantId	string	The tenant ID of resource.
type	ResourceIdentityType	The identity type.

LevelType

Level of the status.

Name	Type	Description
Error	string
Information	string
Warning	string

Plan

Plan for the resource.

Name	Type	Description
name	string	A user defined name of the 3rd Party Artifact that is being procured.
product	string	The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
promotionCode	string	A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
publisher	string	The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
version	string	The version of the desired product/artifact.

ProvisioningState

Status of installation of this extension.

Name	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ResourceIdentityType

The identity type.

Name	Type	Description
SystemAssigned	string

Scope

Scope of the extension. It can be either Cluster or Namespace; but not both.

Name	Type	Description
cluster	ScopeCluster	Specifies that the scope of the extension is Cluster
namespace	ScopeNamespace	Specifies that the scope of the extension is Namespace

ScopeCluster

Specifies that the scope of the extension is Cluster

Name	Type	Description
releaseNamespace	string	Namespace where the extension Release must be placed, for a Cluster scoped extension. If this namespace does not exist, it will be created

ScopeNamespace

Specifies that the scope of the extension is Namespace

Name	Type	Description
targetNamespace	string	Namespace where the extension will be created for an Namespace scoped extension. If this namespace does not exist, it will be created

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via

Extensions - Create

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Create Extension

Sample request

Sample response

Create Extension with Plan

Sample request

Sample response

Definitions

AksAssignedIdentity

AKSIdentityType

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Extension

ExtensionStatus

Identity

LevelType

Plan

ProvisioningState

ResourceIdentityType

Scope

ScopeCluster

ScopeNamespace

systemData

Additional resources