Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. kusto
  5. getSandboxCustomImage
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.kusto.getSandboxCustomImage

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Returns a sandbox custom image

Uses Azure REST API version 2024-04-13.

Other available API versions: 2023-08-15. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native kusto [ApiVersion]. See the version guide for details.

Using getSandboxCustomImage

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSandboxCustomImage(args: GetSandboxCustomImageArgs, opts?: InvokeOptions): Promise<GetSandboxCustomImageResult>
function getSandboxCustomImageOutput(args: GetSandboxCustomImageOutputArgs, opts?: InvokeOptions): Output<GetSandboxCustomImageResult>
Copy
def get_sandbox_custom_image(cluster_name: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             sandbox_custom_image_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetSandboxCustomImageResult
def get_sandbox_custom_image_output(cluster_name: Optional[pulumi.Input[str]] = None,
                             resource_group_name: Optional[pulumi.Input[str]] = None,
                             sandbox_custom_image_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetSandboxCustomImageResult]
Copy
func LookupSandboxCustomImage(ctx *Context, args *LookupSandboxCustomImageArgs, opts ...InvokeOption) (*LookupSandboxCustomImageResult, error)
func LookupSandboxCustomImageOutput(ctx *Context, args *LookupSandboxCustomImageOutputArgs, opts ...InvokeOption) LookupSandboxCustomImageResultOutput
Copy

> Note: This function is named LookupSandboxCustomImage in the Go SDK.

public static class GetSandboxCustomImage 
{
    public static Task<GetSandboxCustomImageResult> InvokeAsync(GetSandboxCustomImageArgs args, InvokeOptions? opts = null)
    public static Output<GetSandboxCustomImageResult> Invoke(GetSandboxCustomImageInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSandboxCustomImageResult> getSandboxCustomImage(GetSandboxCustomImageArgs args, InvokeOptions options)
public static Output<GetSandboxCustomImageResult> getSandboxCustomImage(GetSandboxCustomImageArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:kusto:getSandboxCustomImage
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SandboxCustomImageName
This property is required.
Changes to this property will trigger replacement.
string
The name of the sandbox custom image.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SandboxCustomImageName
This property is required.
Changes to this property will trigger replacement.
string
The name of the sandbox custom image.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
sandboxCustomImageName
This property is required.
Changes to this property will trigger replacement.
String
The name of the sandbox custom image.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
sandboxCustomImageName
This property is required.
Changes to this property will trigger replacement.
string
The name of the sandbox custom image.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Kusto cluster.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
sandbox_custom_image_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the sandbox custom image.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
sandboxCustomImageName
This property is required.
Changes to this property will trigger replacement.
String
The name of the sandbox custom image.

getSandboxCustomImage Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Language string
The language name, for example Python.
Name string
The name of the resource
ProvisioningState string
The provisioned state of the resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
BaseImageName string
The base image name on which the custom image is built on top of. It can be one of the LanguageExtensionImageName (e.g.: 'Python3_10_8', 'Python3_10_8_DL') or the name of an existing custom image. Either this property or languageVersion should be specified.
LanguageVersion string
The version of the language. Either this property or baseImageName should be specified.
RequirementsFileContent string
The requirements file content.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Language string
The language name, for example Python.
Name string
The name of the resource
ProvisioningState string
The provisioned state of the resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
BaseImageName string
The base image name on which the custom image is built on top of. It can be one of the LanguageExtensionImageName (e.g.: 'Python3_10_8', 'Python3_10_8_DL') or the name of an existing custom image. Either this property or languageVersion should be specified.
LanguageVersion string
The version of the language. Either this property or baseImageName should be specified.
RequirementsFileContent string
The requirements file content.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
language String
The language name, for example Python.
name String
The name of the resource
provisioningState String
The provisioned state of the resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
baseImageName String
The base image name on which the custom image is built on top of. It can be one of the LanguageExtensionImageName (e.g.: 'Python3_10_8', 'Python3_10_8_DL') or the name of an existing custom image. Either this property or languageVersion should be specified.
languageVersion String
The version of the language. Either this property or baseImageName should be specified.
requirementsFileContent String
The requirements file content.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
language string
The language name, for example Python.
name string
The name of the resource
provisioningState string
The provisioned state of the resource.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
baseImageName string
The base image name on which the custom image is built on top of. It can be one of the LanguageExtensionImageName (e.g.: 'Python3_10_8', 'Python3_10_8_DL') or the name of an existing custom image. Either this property or languageVersion should be specified.
languageVersion string
The version of the language. Either this property or baseImageName should be specified.
requirementsFileContent string
The requirements file content.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
language str
The language name, for example Python.
name str
The name of the resource
provisioning_state str
The provisioned state of the resource.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
base_image_name str
The base image name on which the custom image is built on top of. It can be one of the LanguageExtensionImageName (e.g.: 'Python3_10_8', 'Python3_10_8_DL') or the name of an existing custom image. Either this property or languageVersion should be specified.
language_version str
The version of the language. Either this property or baseImageName should be specified.
requirements_file_content str
The requirements file content.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
language String
The language name, for example Python.
name String
The name of the resource
provisioningState String
The provisioned state of the resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
baseImageName String
The base image name on which the custom image is built on top of. It can be one of the LanguageExtensionImageName (e.g.: 'Python3_10_8', 'Python3_10_8_DL') or the name of an existing custom image. Either this property or languageVersion should be specified.
languageVersion String
The version of the language. Either this property or baseImageName should be specified.
requirementsFileContent String
The requirements file content.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native