Sandbox Custom Images - Create Or Update

サービス:

Azure Kusto

API バージョン:

2024-04-13

サンドボックス カスタム イメージを作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/sandboxCustomImages/{sandboxCustomImageName}?api-version=2024-04-13

URI パラメーター

名前	/	必須	型	説明
clusterName	path	True	string pattern: ^.*$	Kusto クラスターの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前では大文字と小文字が区別されません。
sandboxCustomImageName	path	True	string pattern: ^.*$	サンドボックス カスタム イメージの名前。
subscriptionId	path	True	string minLength: 1	ターゲット サブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
properties.language	True	language	言語名 (Python など)。
properties.baseImageName		string	カスタム イメージの上に構築される基本イメージ名。 LanguageExtensionImageName (例: 'Python3_10_8'、'Python3_10_8_DL') のいずれか、または既存のカスタム イメージの名前を指定できます。 このプロパティまたは languageVersion を指定する必要があります。
properties.languageVersion		string	言語のバージョン。 このプロパティまたは baseImageName を指定する必要があります。
properties.requirementsFileContent		string	要件ファイルの内容。

応答

名前	型	説明
200 OK	SandboxCustomImage	サンドボックス カスタム イメージが正常に更新されました。
201 Created	SandboxCustomImage	サンドボックス カスタム イメージが正常に作成されました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

例

KustoSandboxCustomImagesCreateOrUpdate

KustoSandboxCustomImagesCreateOrUpdateWithCustomBaseImage

KustoSandboxCustomImagesCreateOrUpdateWithManagedBaseImage

KustoSandboxCustomImagesCreateOrUpdate

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/kustoCluster/sandboxCustomImages/customImage8?api-version=2024-04-13

{
  "properties": {
    "language": "Python",
    "languageVersion": "3.10.8",
    "requirementsFileContent": "Requests"
  }
}

Java

import com.azure.resourcemanager.kusto.models.Language;

/**
 * Samples for SandboxCustomImages CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/
     * KustoSandboxCustomImagesCreateOrUpdate.json
     */
    /**
     * Sample code: KustoSandboxCustomImagesCreateOrUpdate.
     * 
     * @param manager Entry point to KustoManager.
     */
    public static void kustoSandboxCustomImagesCreateOrUpdate(com.azure.resourcemanager.kusto.KustoManager manager) {
        manager.sandboxCustomImages().define("customImage8").withExistingCluster("kustorptest", "kustoCluster")
            .withLanguage(Language.PYTHON).withLanguageVersion("3.10.8").withRequirementsFileContent("Requests")
            .create();
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.kusto import KustoManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-kusto
# USAGE
    python kusto_sandbox_custom_images_create_or_update.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 = KustoManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="12345678-1234-1234-1234-123456789098",
    )

    response = client.sandbox_custom_images.begin_create_or_update(
        resource_group_name="kustorptest",
        cluster_name="kustoCluster",
        sandbox_custom_image_name="customImage8",
        parameters={
            "properties": {"language": "Python", "languageVersion": "3.10.8", "requirementsFileContent": "Requests"}
        },
    ).result()
    print(response)


# x-ms-original-file: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoSandboxCustomImagesCreateOrUpdate.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

Go

package armkusto_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/kusto/armkusto/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b8adce17dc500f338f86f18af30aac61dcb71c5f/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoSandboxCustomImagesCreateOrUpdate.json
func ExampleSandboxCustomImagesClient_BeginCreateOrUpdate_kustoSandboxCustomImagesCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSandboxCustomImagesClient().BeginCreateOrUpdate(ctx, "kustorptest", "kustoCluster", "customImage8", armkusto.SandboxCustomImage{
		Properties: &armkusto.SandboxCustomImageProperties{
			LanguageVersion:         to.Ptr("3.10.8"),
			RequirementsFileContent: to.Ptr("Requests"),
			Language:                to.Ptr(armkusto.LanguagePython),
		},
	}, 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.SandboxCustomImage = armkusto.SandboxCustomImage{
	// 	Name: to.Ptr("kustoCluster/customImage8"),
	// 	Type: to.Ptr("Microsoft.Kusto/Clusters/SandboxCustomImages"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/SandboxCustomImages/customImage8"),
	// 	Properties: &armkusto.SandboxCustomImageProperties{
	// 		LanguageVersion: to.Ptr("3.10.8"),
	// 		ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 		RequirementsFileContent: to.Ptr("Requests"),
	// 		Language: to.Ptr(armkusto.LanguagePython),
	// 	},
	// }
}

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

JavaScript

const { KustoManagementClient } = require("@azure/arm-kusto");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Creates or updates a sandbox custom image.
 *
 * @summary Creates or updates a sandbox custom image.
 * x-ms-original-file: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoSandboxCustomImagesCreateOrUpdate.json
 */
async function kustoSandboxCustomImagesCreateOrUpdate() {
  const subscriptionId =
    process.env["KUSTO_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-123456789098";
  const resourceGroupName = process.env["KUSTO_RESOURCE_GROUP"] || "kustorptest";
  const clusterName = "kustoCluster";
  const sandboxCustomImageName = "customImage8";
  const parameters = {
    languageVersion: "3.10.8",
    requirementsFileContent: "Requests",
    language: "Python",
  };
  const credential = new DefaultAzureCredential();
  const client = new KustoManagementClient(credential, subscriptionId);
  const result = await client.sandboxCustomImages.beginCreateOrUpdateAndWait(
    resourceGroupName,
    clusterName,
    sandboxCustomImageName,
    parameters,
  );
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Kusto.Models;
using Azure.ResourceManager.Kusto;

// Generated from example definition: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoSandboxCustomImagesCreateOrUpdate.json
// this example is just showing the usage of "SandboxCustomImages_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this KustoClusterResource created on azure
// for more information of creating KustoClusterResource, please refer to the document of KustoClusterResource
string subscriptionId = "12345678-1234-1234-1234-123456789098";
string resourceGroupName = "kustorptest";
string clusterName = "kustoCluster";
ResourceIdentifier kustoClusterResourceId = KustoClusterResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, clusterName);
KustoClusterResource kustoCluster = client.GetKustoClusterResource(kustoClusterResourceId);

// get the collection of this SandboxCustomImageResource
SandboxCustomImageCollection collection = kustoCluster.GetSandboxCustomImages();

// invoke the operation
string sandboxCustomImageName = "customImage8";
SandboxCustomImageData data = new SandboxCustomImageData
{
    Language = SandboxCustomImageLanguage.Python,
    LanguageVersion = "3.10.8",
    RequirementsFileContent = "Requests",
};
ArmOperation<SandboxCustomImageResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, sandboxCustomImageName, data);
SandboxCustomImageResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SandboxCustomImageData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

応答のサンプル

状態コード:

200

Azure-AsyncOperation: https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/providers/Microsoft.Kusto/locations/westus/operationResults/742bef43-608b-4b58-ba96-6f7a32ec5f12?api-version=2021-02-01

{
  "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/SandboxCustomImages/customImage8",
  "name": "kustoCluster/customImage8",
  "type": "Microsoft.Kusto/Clusters/SandboxCustomImages",
  "properties": {
    "language": "Python",
    "languageVersion": "3.10.8",
    "requirementsFileContent": "Requests",
    "provisioningState": "Accepted"
  }
}

状態コード:

201

Azure-AsyncOperation: https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/providers/Microsoft.Kusto/locations/westus/operationResults/742bef43-608b-4b58-ba96-6f7a32ec5f12?api-version=2021-02-01

{
  "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/SandboxCustomImages/customImage8",
  "name": "kustoCluster/customImage8",
  "type": "Microsoft.Kusto/Clusters/SandboxCustomImages",
  "properties": {
    "language": "Python",
    "languageVersion": "3.10.8",
    "requirementsFileContent": "Requests",
    "provisioningState": "Creating"
  }
}

KustoSandboxCustomImagesCreateOrUpdateWithCustomBaseImage

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/kustoCluster/sandboxCustomImages/customImage2?api-version=2024-04-13

{
  "properties": {
    "language": "Python",
    "baseImageName": "customImage1",
    "requirementsFileContent": "Requests"
  }
}

Java

import com.azure.resourcemanager.kusto.models.Language;

/**
 * Samples for SandboxCustomImages CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/
     * KustoSandboxCustomImagesCreateOrUpdateWithCustomBaseImage.json
     */
    /**
     * Sample code: KustoSandboxCustomImagesCreateOrUpdateWithCustomBaseImage.
     * 
     * @param manager Entry point to KustoManager.
     */
    public static void kustoSandboxCustomImagesCreateOrUpdateWithCustomBaseImage(
        com.azure.resourcemanager.kusto.KustoManager manager) {
        manager.sandboxCustomImages().define("customImage2").withExistingCluster("kustorptest", "kustoCluster")
            .withLanguage(Language.PYTHON).withBaseImageName("customImage1").withRequirementsFileContent("Requests")
            .create();
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.kusto import KustoManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-kusto
# USAGE
    python kusto_sandbox_custom_images_create_or_update_with_custom_base_image.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 = KustoManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="12345678-1234-1234-1234-123456789098",
    )

    response = client.sandbox_custom_images.begin_create_or_update(
        resource_group_name="kustorptest",
        cluster_name="kustoCluster",
        sandbox_custom_image_name="customImage2",
        parameters={
            "properties": {"baseImageName": "customImage1", "language": "Python", "requirementsFileContent": "Requests"}
        },
    ).result()
    print(response)


# x-ms-original-file: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoSandboxCustomImagesCreateOrUpdateWithCustomBaseImage.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

Go

package armkusto_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/kusto/armkusto/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b8adce17dc500f338f86f18af30aac61dcb71c5f/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoSandboxCustomImagesCreateOrUpdateWithCustomBaseImage.json
func ExampleSandboxCustomImagesClient_BeginCreateOrUpdate_kustoSandboxCustomImagesCreateOrUpdateWithCustomBaseImage() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSandboxCustomImagesClient().BeginCreateOrUpdate(ctx, "kustorptest", "kustoCluster", "customImage2", armkusto.SandboxCustomImage{
		Properties: &armkusto.SandboxCustomImageProperties{
			BaseImageName:           to.Ptr("customImage1"),
			RequirementsFileContent: to.Ptr("Requests"),
			Language:                to.Ptr(armkusto.LanguagePython),
		},
	}, 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.SandboxCustomImage = armkusto.SandboxCustomImage{
	// 	Name: to.Ptr("kustoCluster/customImage2"),
	// 	Type: to.Ptr("Microsoft.Kusto/Clusters/SandboxCustomImages"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/SandboxCustomImages/customImage2"),
	// 	Properties: &armkusto.SandboxCustomImageProperties{
	// 		BaseImageName: to.Ptr("customImage1"),
	// 		ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 		RequirementsFileContent: to.Ptr("Requests"),
	// 		Language: to.Ptr(armkusto.LanguagePython),
	// 	},
	// }
}

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

JavaScript

const { KustoManagementClient } = require("@azure/arm-kusto");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Creates or updates a sandbox custom image.
 *
 * @summary Creates or updates a sandbox custom image.
 * x-ms-original-file: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoSandboxCustomImagesCreateOrUpdateWithCustomBaseImage.json
 */
async function kustoSandboxCustomImagesCreateOrUpdateWithCustomBaseImage() {
  const subscriptionId =
    process.env["KUSTO_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-123456789098";
  const resourceGroupName = process.env["KUSTO_RESOURCE_GROUP"] || "kustorptest";
  const clusterName = "kustoCluster";
  const sandboxCustomImageName = "customImage2";
  const parameters = {
    baseImageName: "customImage1",
    requirementsFileContent: "Requests",
    language: "Python",
  };
  const credential = new DefaultAzureCredential();
  const client = new KustoManagementClient(credential, subscriptionId);
  const result = await client.sandboxCustomImages.beginCreateOrUpdateAndWait(
    resourceGroupName,
    clusterName,
    sandboxCustomImageName,
    parameters,
  );
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Kusto.Models;
using Azure.ResourceManager.Kusto;

// Generated from example definition: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoSandboxCustomImagesCreateOrUpdateWithCustomBaseImage.json
// this example is just showing the usage of "SandboxCustomImages_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this KustoClusterResource created on azure
// for more information of creating KustoClusterResource, please refer to the document of KustoClusterResource
string subscriptionId = "12345678-1234-1234-1234-123456789098";
string resourceGroupName = "kustorptest";
string clusterName = "kustoCluster";
ResourceIdentifier kustoClusterResourceId = KustoClusterResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, clusterName);
KustoClusterResource kustoCluster = client.GetKustoClusterResource(kustoClusterResourceId);

// get the collection of this SandboxCustomImageResource
SandboxCustomImageCollection collection = kustoCluster.GetSandboxCustomImages();

// invoke the operation
string sandboxCustomImageName = "customImage2";
SandboxCustomImageData data = new SandboxCustomImageData
{
    Language = SandboxCustomImageLanguage.Python,
    BaseImageName = "customImage1",
    RequirementsFileContent = "Requests",
};
ArmOperation<SandboxCustomImageResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, sandboxCustomImageName, data);
SandboxCustomImageResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SandboxCustomImageData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

応答のサンプル

状態コード:

200

Azure-AsyncOperation: https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/providers/Microsoft.Kusto/locations/westus/operationResults/742bef43-608b-4b58-ba96-6f7a32ec5f12?api-version=2021-02-01

{
  "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/SandboxCustomImages/customImage2",
  "name": "kustoCluster/customImage2",
  "type": "Microsoft.Kusto/Clusters/SandboxCustomImages",
  "properties": {
    "language": "Python",
    "baseImageName": "customImage1",
    "requirementsFileContent": "Requests",
    "provisioningState": "Succeeded"
  }
}

状態コード:

201

Azure-AsyncOperation: https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/providers/Microsoft.Kusto/locations/westus/operationResults/742bef43-608b-4b58-ba96-6f7a32ec5f12?api-version=2021-02-01

{
  "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/SandboxCustomImages/customImage2",
  "name": "kustoCluster/customImage2",
  "type": "Microsoft.Kusto/Clusters/SandboxCustomImages",
  "properties": {
    "language": "Python",
    "baseImageName": "customImage1",
    "requirementsFileContent": "Requests",
    "provisioningState": "Creating"
  }
}

KustoSandboxCustomImagesCreateOrUpdateWithManagedBaseImage

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/kustoCluster/sandboxCustomImages/customImage2?api-version=2024-04-13

{
  "properties": {
    "language": "Python",
    "baseImageName": "Python3_10_8",
    "requirementsFileContent": "Requests"
  }
}

Java

import com.azure.resourcemanager.kusto.models.Language;

/**
 * Samples for SandboxCustomImages CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/
     * KustoSandboxCustomImagesCreateOrUpdateWithManagedBaseImage.json
     */
    /**
     * Sample code: KustoSandboxCustomImagesCreateOrUpdateWithManagedBaseImage.
     * 
     * @param manager Entry point to KustoManager.
     */
    public static void kustoSandboxCustomImagesCreateOrUpdateWithManagedBaseImage(
        com.azure.resourcemanager.kusto.KustoManager manager) {
        manager.sandboxCustomImages().define("customImage2").withExistingCluster("kustorptest", "kustoCluster")
            .withLanguage(Language.PYTHON).withBaseImageName("Python3_10_8").withRequirementsFileContent("Requests")
            .create();
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.kusto import KustoManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-kusto
# USAGE
    python kusto_sandbox_custom_images_create_or_update_with_managed_base_image.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 = KustoManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="12345678-1234-1234-1234-123456789098",
    )

    response = client.sandbox_custom_images.begin_create_or_update(
        resource_group_name="kustorptest",
        cluster_name="kustoCluster",
        sandbox_custom_image_name="customImage2",
        parameters={
            "properties": {"baseImageName": "Python3_10_8", "language": "Python", "requirementsFileContent": "Requests"}
        },
    ).result()
    print(response)


# x-ms-original-file: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoSandboxCustomImagesCreateOrUpdateWithManagedBaseImage.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

Go

package armkusto_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/kusto/armkusto/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b8adce17dc500f338f86f18af30aac61dcb71c5f/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoSandboxCustomImagesCreateOrUpdateWithManagedBaseImage.json
func ExampleSandboxCustomImagesClient_BeginCreateOrUpdate_kustoSandboxCustomImagesCreateOrUpdateWithManagedBaseImage() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSandboxCustomImagesClient().BeginCreateOrUpdate(ctx, "kustorptest", "kustoCluster", "customImage2", armkusto.SandboxCustomImage{
		Properties: &armkusto.SandboxCustomImageProperties{
			BaseImageName:           to.Ptr("Python3_10_8"),
			RequirementsFileContent: to.Ptr("Requests"),
			Language:                to.Ptr(armkusto.LanguagePython),
		},
	}, 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.SandboxCustomImage = armkusto.SandboxCustomImage{
	// 	Name: to.Ptr("kustoCluster/customImage2"),
	// 	Type: to.Ptr("Microsoft.Kusto/Clusters/SandboxCustomImages"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/SandboxCustomImages/customImage2"),
	// 	Properties: &armkusto.SandboxCustomImageProperties{
	// 		BaseImageName: to.Ptr("Python3_10_8"),
	// 		ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 		RequirementsFileContent: to.Ptr("Requests"),
	// 		Language: to.Ptr(armkusto.LanguagePython),
	// 	},
	// }
}

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

JavaScript

const { KustoManagementClient } = require("@azure/arm-kusto");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Creates or updates a sandbox custom image.
 *
 * @summary Creates or updates a sandbox custom image.
 * x-ms-original-file: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoSandboxCustomImagesCreateOrUpdateWithManagedBaseImage.json
 */
async function kustoSandboxCustomImagesCreateOrUpdateWithManagedBaseImage() {
  const subscriptionId =
    process.env["KUSTO_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-123456789098";
  const resourceGroupName = process.env["KUSTO_RESOURCE_GROUP"] || "kustorptest";
  const clusterName = "kustoCluster";
  const sandboxCustomImageName = "customImage2";
  const parameters = {
    baseImageName: "Python3_10_8",
    requirementsFileContent: "Requests",
    language: "Python",
  };
  const credential = new DefaultAzureCredential();
  const client = new KustoManagementClient(credential, subscriptionId);
  const result = await client.sandboxCustomImages.beginCreateOrUpdateAndWait(
    resourceGroupName,
    clusterName,
    sandboxCustomImageName,
    parameters,
  );
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Kusto.Models;
using Azure.ResourceManager.Kusto;

// Generated from example definition: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoSandboxCustomImagesCreateOrUpdateWithManagedBaseImage.json
// this example is just showing the usage of "SandboxCustomImages_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this KustoClusterResource created on azure
// for more information of creating KustoClusterResource, please refer to the document of KustoClusterResource
string subscriptionId = "12345678-1234-1234-1234-123456789098";
string resourceGroupName = "kustorptest";
string clusterName = "kustoCluster";
ResourceIdentifier kustoClusterResourceId = KustoClusterResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, clusterName);
KustoClusterResource kustoCluster = client.GetKustoClusterResource(kustoClusterResourceId);

// get the collection of this SandboxCustomImageResource
SandboxCustomImageCollection collection = kustoCluster.GetSandboxCustomImages();

// invoke the operation
string sandboxCustomImageName = "customImage2";
SandboxCustomImageData data = new SandboxCustomImageData
{
    Language = SandboxCustomImageLanguage.Python,
    BaseImageName = "Python3_10_8",
    RequirementsFileContent = "Requests",
};
ArmOperation<SandboxCustomImageResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, sandboxCustomImageName, data);
SandboxCustomImageResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SandboxCustomImageData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

応答のサンプル

状態コード:

200

Azure-AsyncOperation: https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/providers/Microsoft.Kusto/locations/westus/operationResults/742bef43-608b-4b58-ba96-6f7a32ec5f12?api-version=2021-02-01

{
  "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/SandboxCustomImages/customImage2",
  "name": "kustoCluster/customImage2",
  "type": "Microsoft.Kusto/Clusters/SandboxCustomImages",
  "properties": {
    "language": "Python",
    "baseImageName": "Python3_10_8",
    "requirementsFileContent": "Requests",
    "provisioningState": "Accepted"
  }
}

状態コード:

201

Azure-AsyncOperation: https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/providers/Microsoft.Kusto/locations/westus/operationResults/742bef43-608b-4b58-ba96-6f7a32ec5f12?api-version=2021-02-01

{
  "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/SandboxCustomImages/customImage2",
  "name": "kustoCluster/customImage2",
  "type": "Microsoft.Kusto/Clusters/SandboxCustomImages",
  "properties": {
    "language": "Python",
    "baseImageName": "Python3_10_8",
    "requirementsFileContent": "Requests",
    "provisioningState": "Creating"
  }
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
language	言語名 (Python など)。
ProvisioningState	リソースのプロビジョニング済み状態。
SandboxCustomImage	Kusto サンドボックスのカスタム イメージを表すクラス。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

language

列挙

言語名 (Python など)。

値	説明
Python

ProvisioningState

列挙

リソースのプロビジョニング済み状態。

値	説明
Canceled
Creating
Deleting
Failed
Moving
Running
Succeeded

SandboxCustomImage

Object

Kusto サンドボックスのカスタム イメージを表すクラス。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.baseImageName	string	カスタム イメージの上に構築される基本イメージ名。 LanguageExtensionImageName (例: 'Python3_10_8'、'Python3_10_8_DL') のいずれか、または既存のカスタム イメージの名前を指定できます。 このプロパティまたは languageVersion を指定する必要があります。
properties.language	language	言語名 (Python など)。
properties.languageVersion	string	言語のバージョン。 このプロパティまたは baseImageName を指定する必要があります。
properties.provisioningState	ProvisioningState	リソースのプロビジョニング済み状態。
properties.requirementsFileContent	string	要件ファイルの内容。
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"