Extensions - Create

リファレンス

サービス:: Kubernetes Configuration

API バージョン:: 2023-05-01

新しい Kubernetes クラスター拡張機能を作成します。

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

URI パラメーター

名前	/	必須	型	説明
clusterName	path	True	string	kubernetes クラスターの名前。
clusterResourceName	path	True	string	Kubernetes クラスターリソース名 (managedClusters、connectedClusters、provisionedClusters など)。
clusterRp	path	True	string	Kubernetes クラスター RP -つまり、Microsoft.ContainerService、Microsoft.Kubernetes、Microsoft.HybridContainerService。
extensionName	path	True	string	拡張機能の名前。
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	型	説明
identity	Identity	拡張機能リソースの ID
plan	Plan	プラン情報。
properties.aksAssignedIdentity	AksAssignedIdentity	AKS クラスター内の拡張機能リソースの ID
properties.autoUpgradeMinorVersion	boolean	この拡張機能がマイナーバージョンの自動アップグレードに参加するかどうかに注意するフラグ。
properties.configurationProtectedSettings	object	この拡張機能を構成するための名前と値のペアとして、機密性の高い構成設定。
properties.configurationSettings	object	この拡張機能を構成するための名前と値のペアとしての構成設定。
properties.extensionType	string	拡張機能の種類。このリソースはのインスタンスです。これは、拡張機能パブリッシャーによって Microsoft.KubernetesConfiguration に登録されている拡張機能の種類のいずれかである必要があります。
properties.releaseTrain	string	Releaseこの拡張機能は、autoUpgradeMinorVersion が 'true' の場合にのみ、自動アップグレード (Stable、Preview など) に参加します。
properties.scope	Scope	拡張機能がインストールされるスコープ。
properties.statuses	ExtensionStatus[]	この拡張機能の状態。
properties.version	string	この拡張機能の拡張機能のユーザー指定バージョンを 'pin' に設定します。 'version' を使用するには、autoUpgradeMinorVersion を 'false' にする必要があります。

応答

名前	型	説明
200 OK	Extension	既存のリソースに対して要求が正常に受信されました。
201 Created	Extension	要求が正常に受信されました。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントの借用

例

Create Extension

Create Extension with Plan

Create Extension

要求のサンプル

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

応答のサンプル

状態コード:: 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
  }
}

状態コード:: 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

要求のサンプル

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

応答のサンプル

状態コード:: 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
  }
}

状態コード:: 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
  }
}

定義

名前	説明
AksAssignedIdentity	AKS クラスター内の拡張機能リソースの ID
AKSIdentityType	ID の種類。
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
Extension	Extension オブジェクト。
ExtensionStatus	拡張機能の状態。
Identity	リソースの ID。
LevelType	状態のレベル。
Plan	リソースの計画です。
ProvisioningState	この拡張機能のインストールの状態。
ResourceIdentityType	ID の種類。
Scope	拡張機能のスコープ。クラスターまたは名前空間のいずれかを指定できます。ただし、両方ではありません。
ScopeCluster	拡張機能のスコープがクラスターであることを指定します
ScopeNamespace	拡張機能のスコープが名前空間であることを指定します
systemData	リソースの作成と最後の変更に関連するメタデータ。

AksAssignedIdentity

AKS クラスター内の拡張機能リソースの ID

名前	型	説明
principalId	string	リソース ID のプリンシパル ID。
tenantId	string	リソースのテナント ID。
type	AKSIdentityType	ID の種類。

AKSIdentityType

ID の種類。

名前	型	説明
SystemAssigned	string
UserAssigned	string

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

Extension

Extension オブジェクト。

名前	型	規定値	説明
id	string		リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		拡張機能リソースの ID
name	string		リソースの名前
plan	Plan		プラン情報。
properties.aksAssignedIdentity	AksAssignedIdentity		AKS クラスター内の拡張機能リソースの ID
properties.autoUpgradeMinorVersion	boolean	True	この拡張機能がマイナーバージョンの自動アップグレードに参加するかどうかに注意するフラグ。
properties.configurationProtectedSettings	object		この拡張機能を構成するための名前と値のペアとして、機密性の高い構成設定。
properties.configurationSettings	object		この拡張機能を構成するための名前と値のペアとしての構成設定。
properties.currentVersion	string		現在インストールされている拡張機能のバージョン。
properties.customLocationSettings	object		カスタムの場所の設定プロパティ。
properties.errorInfo	ErrorDetail		エージェントからのエラー情報 - インストール中のエラーなど。
properties.extensionType	string		拡張機能の種類。このリソースはのインスタンスです。これは、拡張機能パブリッシャーによって Microsoft.KubernetesConfiguration に登録されている拡張機能の種類のいずれかである必要があります。
properties.isSystemExtension	boolean	False	この拡張機能がシステム拡張機能の場合に注意するフラグ
properties.packageUri	string		Helm パッケージの URI
properties.provisioningState	ProvisioningState		この拡張機能のインストールの状態。
properties.releaseTrain	string	Stable	Releaseこの拡張機能は、autoUpgradeMinorVersion が 'true' の場合にのみ、自動アップグレード (Stable、Preview など) に参加します。
properties.scope	Scope		拡張機能がインストールされるスコープ。
properties.statuses	ExtensionStatus[]		この拡張機能の状態。
properties.version	string		この拡張機能の拡張機能のユーザー指定バージョンを 'pin' に設定します。 'version' を使用するには、autoUpgradeMinorVersion を 'false' にする必要があります。
systemData	systemData		最上位レベルのメタデータ https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources
type	string		リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ExtensionStatus

拡張機能の状態。

名前	型	規定値	説明
code	string		拡張機能によって提供される状態コード
displayStatus	string		拡張機能の状態の簡単な説明。
level	LevelType	Information	状態のレベル。
message	string		拡張機能からの状態の詳細メッセージ。
time	string		インストール状態の時刻を示す DateLiteral (ISO8601ごと)。

Identity

リソースの ID。

名前	型	説明
principalId	string	リソース ID のプリンシパル ID。
tenantId	string	リソースのテナント ID。
type	ResourceIdentityType	ID の種類。

LevelType

状態のレベル。

名前	型	説明
Error	string
Information	string
Warning	string

Plan

リソースの計画です。

名前	型	説明
name	string	調達中のサードパーティ成果物のユーザー定義名。
product	string	調達中のサードパーティの成果物。例: NewRelic。製品は、Data Market のオンボード時に成果物に指定された OfferID にマップされます。
promotionCode	string	発行元は、上記の製品/成果物に対して Data Market でプロビジョニングされたプロモーションコードを提供しました。
publisher	string	購入中のサードパーティ成果物の発行元。例: NewRelic
version	string	目的の製品/成果物のバージョン。

ProvisioningState

この拡張機能のインストールの状態。

名前	型	説明
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ResourceIdentityType

ID の種類。

名前	型	説明
SystemAssigned	string

Scope

拡張機能のスコープ。クラスターまたは名前空間のいずれかを指定できます。ただし、両方ではありません。

名前	型	説明
cluster	ScopeCluster	拡張機能のスコープがクラスターであることを指定します
namespace	ScopeNamespace	拡張機能のスコープが名前空間であることを指定します

ScopeCluster

拡張機能のスコープがクラスターであることを指定します

名前	型	説明
releaseNamespace	string	クラスタースコープ拡張機能の場合、拡張機能リリースを配置する必要がある名前空間。この名前空間が存在しない場合は、作成されます

ScopeNamespace

拡張機能のスコープが名前空間であることを指定します

名前	型	説明
targetNamespace	string	名前空間スコープの拡張機能に対して拡張機能が作成される名前空間。この名前空間が存在しない場合は、作成されます

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

Extensions - Create

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

Create Extension

要求のサンプル

応答のサンプル

Create Extension with Plan

要求のサンプル

応答のサンプル

定義

AksAssignedIdentity

AKSIdentityType

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Extension

ExtensionStatus

Identity

LevelType

Plan

ProvisioningState

ResourceIdentityType

Scope

ScopeCluster

ScopeNamespace

systemData

その他のリソース