@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 13 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* An object that represents a machine learning workspace.
*
* Uses Azure REST API version 2024-10-01. In version 2.x of the Azure Native provider, it used API version 2023-04-01.
*
* Other available API versions: 2020-05-01-preview, 2020-05-15-preview, 2020-06-01, 2020-08-01, 2020-09-01-preview, 2021-01-01, 2021-03-01-preview, 2021-04-01, 2021-07-01, 2022-01-01-preview, 2022-02-01-preview, 2022-05-01, 2022-06-01-preview, 2022-10-01, 2022-10-01-preview, 2022-12-01-preview, 2023-02-01-preview, 2023-04-01, 2023-04-01-preview, 2023-06-01-preview, 2023-08-01-preview, 2023-10-01, 2024-01-01-preview, 2024-04-01, 2024-07-01-preview, 2024-10-01-preview, 2025-01-01-preview, 2025-04-01, 2025-04-01-preview, 2025-06-01, 2025-07-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native machinelearningservices [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Workspace extends pulumi.CustomResource {
/**
* Get an existing Workspace resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Workspace;
/**
* Returns true if the given object is an instance of Workspace. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Workspace;
/**
* The flag to indicate whether to allow public access when behind VNet.
*/
readonly allowPublicAccessWhenBehindVnet: pulumi.Output<boolean | undefined>;
/**
* ARM id of the application insights associated with this workspace.
*/
readonly applicationInsights: pulumi.Output<string | undefined>;
readonly associatedWorkspaces: pulumi.Output<string[] | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* ARM id of the container registry associated with this workspace.
*/
readonly containerRegistry: pulumi.Output<string | undefined>;
/**
* The description of this workspace.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Url for the discovery service to identify regional endpoints for machine learning experimentation services
*/
readonly discoveryUrl: pulumi.Output<string | undefined>;
readonly enableDataIsolation: pulumi.Output<boolean | undefined>;
/**
* The encryption settings of Azure ML workspace.
*/
readonly encryption: pulumi.Output<outputs.machinelearningservices.EncryptionPropertyResponse | undefined>;
/**
* Settings for feature store type workspace.
*/
readonly featureStoreSettings: pulumi.Output<outputs.machinelearningservices.FeatureStoreSettingsResponse | undefined>;
/**
* The friendly name for this workspace. This name in mutable
*/
readonly friendlyName: pulumi.Output<string | undefined>;
/**
* The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service
*/
readonly hbiWorkspace: pulumi.Output<boolean | undefined>;
readonly hubResourceId: pulumi.Output<string | undefined>;
/**
* The identity of the resource.
*/
readonly identity: pulumi.Output<outputs.machinelearningservices.ManagedServiceIdentityResponse | undefined>;
/**
* The compute name for image build
*/
readonly imageBuildCompute: pulumi.Output<string | undefined>;
/**
* ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created
*/
readonly keyVault: pulumi.Output<string | undefined>;
readonly kind: pulumi.Output<string | undefined>;
/**
* Specifies the location of the resource.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* Managed Network settings for a machine learning workspace.
*/
readonly managedNetwork: pulumi.Output<outputs.machinelearningservices.ManagedNetworkSettingsResponse | undefined>;
/**
* The URI associated with this workspace that machine learning flow must point at to set up tracking.
*/
readonly mlFlowTrackingUri: pulumi.Output<string>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* The notebook info of Azure ML workspace.
*/
readonly notebookInfo: pulumi.Output<outputs.machinelearningservices.NotebookResourceInfoResponse>;
/**
* The user assigned identity resource id that represents the workspace identity.
*/
readonly primaryUserAssignedIdentity: pulumi.Output<string | undefined>;
/**
* The list of private endpoint connections in the workspace.
*/
readonly privateEndpointConnections: pulumi.Output<outputs.machinelearningservices.PrivateEndpointConnectionResponse[]>;
/**
* Count of private connections in the workspace
*/
readonly privateLinkCount: pulumi.Output<number>;
/**
* The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Whether requests from Public Network are allowed.
*/
readonly publicNetworkAccess: pulumi.Output<string | undefined>;
/**
* Settings for serverless compute created in the workspace
*/
readonly serverlessComputeSettings: pulumi.Output<outputs.machinelearningservices.ServerlessComputeSettingsResponse | undefined>;
/**
* The service managed resource settings.
*/
readonly serviceManagedResourcesSettings: pulumi.Output<outputs.machinelearningservices.ServiceManagedResourcesSettingsResponse | undefined>;
/**
* The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace
*/
readonly serviceProvisionedResourceGroup: pulumi.Output<string>;
/**
* The list of shared private link resources in this workspace.
*/
readonly sharedPrivateLinkResources: pulumi.Output<outputs.machinelearningservices.SharedPrivateLinkResourceResponse[] | undefined>;
/**
* The sku of the workspace.
*/
readonly sku: pulumi.Output<outputs.machinelearningservices.SkuResponse | undefined>;
/**
* ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created
*/
readonly storageAccount: pulumi.Output<string | undefined>;
/**
* If the storage associated with the workspace has hierarchical namespace(HNS) enabled.
*/
readonly storageHnsEnabled: pulumi.Output<boolean>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.machinelearningservices.SystemDataResponse>;
/**
* Contains resource tags defined as key/value pairs.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The tenant id associated with this workspace.
*/
readonly tenantId: pulumi.Output<string>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.
*/
readonly v1LegacyMode: pulumi.Output<boolean | undefined>;
/**
* WorkspaceHub's configuration object.
*/
readonly workspaceHubConfig: pulumi.Output<outputs.machinelearningservices.WorkspaceHubConfigResponse | undefined>;
/**
* The immutable id associated with this workspace.
*/
readonly workspaceId: pulumi.Output<string>;
/**
* Create a Workspace resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: WorkspaceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Workspace resource.
*/
export interface WorkspaceArgs {
/**
* The flag to indicate whether to allow public access when behind VNet.
*/
allowPublicAccessWhenBehindVnet?: pulumi.Input<boolean>;
/**
* ARM id of the application insights associated with this workspace.
*/
applicationInsights?: pulumi.Input<string>;
associatedWorkspaces?: pulumi.Input<pulumi.Input<string>[]>;
/**
* ARM id of the container registry associated with this workspace.
*/
containerRegistry?: pulumi.Input<string>;
/**
* The description of this workspace.
*/
description?: pulumi.Input<string>;
/**
* Url for the discovery service to identify regional endpoints for machine learning experimentation services
*/
discoveryUrl?: pulumi.Input<string>;
enableDataIsolation?: pulumi.Input<boolean>;
/**
* The encryption settings of Azure ML workspace.
*/
encryption?: pulumi.Input<inputs.machinelearningservices.EncryptionPropertyArgs>;
/**
* Settings for feature store type workspace.
*/
featureStoreSettings?: pulumi.Input<inputs.machinelearningservices.FeatureStoreSettingsArgs>;
/**
* The friendly name for this workspace. This name in mutable
*/
friendlyName?: pulumi.Input<string>;
/**
* The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service
*/
hbiWorkspace?: pulumi.Input<boolean>;
hubResourceId?: pulumi.Input<string>;
/**
* The identity of the resource.
*/
identity?: pulumi.Input<inputs.machinelearningservices.ManagedServiceIdentityArgs>;
/**
* The compute name for image build
*/
imageBuildCompute?: pulumi.Input<string>;
/**
* ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created
*/
keyVault?: pulumi.Input<string>;
kind?: pulumi.Input<string>;
/**
* Specifies the location of the resource.
*/
location?: pulumi.Input<string>;
/**
* Managed Network settings for a machine learning workspace.
*/
managedNetwork?: pulumi.Input<inputs.machinelearningservices.ManagedNetworkSettingsArgs>;
/**
* The user assigned identity resource id that represents the workspace identity.
*/
primaryUserAssignedIdentity?: pulumi.Input<string>;
/**
* Whether requests from Public Network are allowed.
*/
publicNetworkAccess?: pulumi.Input<string | enums.machinelearningservices.PublicNetworkAccess>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Settings for serverless compute created in the workspace
*/
serverlessComputeSettings?: pulumi.Input<inputs.machinelearningservices.ServerlessComputeSettingsArgs>;
/**
* The service managed resource settings.
*/
serviceManagedResourcesSettings?: pulumi.Input<inputs.machinelearningservices.ServiceManagedResourcesSettingsArgs>;
/**
* The list of shared private link resources in this workspace.
*/
sharedPrivateLinkResources?: pulumi.Input<pulumi.Input<inputs.machinelearningservices.SharedPrivateLinkResourceArgs>[]>;
/**
* The sku of the workspace.
*/
sku?: pulumi.Input<inputs.machinelearningservices.SkuArgs>;
/**
* ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created
*/
storageAccount?: pulumi.Input<string>;
/**
* Contains resource tags defined as key/value pairs.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.
*/
v1LegacyMode?: pulumi.Input<boolean>;
/**
* WorkspaceHub's configuration object.
*/
workspaceHubConfig?: pulumi.Input<inputs.machinelearningservices.WorkspaceHubConfigArgs>;
/**
* Name of Azure Machine Learning workspace.
*/
workspaceName?: pulumi.Input<string>;
}