import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages a Azure Machine Learning Workspace * * > **Note:** For examples on how to set up the Azure Machine Learning workspace, together with compute and integrated services, see Terraform Quickstart * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const current = azure.core.getClientConfig({}); * const example = new azure.core.ResourceGroup("example", { * name: "example-resources", * location: "West Europe", * }); * const exampleInsights = new azure.appinsights.Insights("example", { * name: "workspace-example-ai", * location: example.location, * resourceGroupName: example.name, * applicationType: "web", * }); * const exampleKeyVault = new azure.keyvault.KeyVault("example", { * name: "workspaceexamplekeyvault", * location: example.location, * resourceGroupName: example.name, * tenantId: current.then(current => current.tenantId), * skuName: "premium", * }); * const exampleAccount = new azure.storage.Account("example", { * name: "workspacestorageaccount", * location: example.location, * resourceGroupName: example.name, * accountTier: "Standard", * accountReplicationType: "GRS", * }); * const exampleWorkspace = new azure.machinelearning.Workspace("example", { * name: "example-workspace", * location: example.location, * resourceGroupName: example.name, * applicationInsightsId: exampleInsights.id, * keyVaultId: exampleKeyVault.id, * storageAccountId: exampleAccount.id, * identity: { * type: "SystemAssigned", * }, * }); * ``` * * ### With Data Encryption * * > **Note:** The Key Vault must enable purge protection. * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const current = azure.core.getClientConfig({}); * const example = new azure.core.ResourceGroup("example", { * name: "example-resources", * location: "West Europe", * }); * const exampleInsights = new azure.appinsights.Insights("example", { * name: "workspace-example-ai", * location: example.location, * resourceGroupName: example.name, * applicationType: "web", * }); * const exampleKeyVault = new azure.keyvault.KeyVault("example", { * name: "workspaceexamplekeyvault", * location: example.location, * resourceGroupName: example.name, * tenantId: current.then(current => current.tenantId), * skuName: "premium", * purgeProtectionEnabled: true, * }); * const exampleAccessPolicy = new azure.keyvault.AccessPolicy("example", { * keyVaultId: exampleKeyVault.id, * tenantId: current.then(current => current.tenantId), * objectId: current.then(current => current.objectId), * keyPermissions: [ * "Create", * "Get", * "Delete", * "Purge", * "GetRotationPolicy", * ], * }); * const exampleAccount = new azure.storage.Account("example", { * name: "workspacestorageaccount", * location: example.location, * resourceGroupName: example.name, * accountTier: "Standard", * accountReplicationType: "GRS", * }); * const exampleKey = new azure.keyvault.Key("example", { * name: "workspaceexamplekeyvaultkey", * keyVaultId: exampleKeyVault.id, * keyType: "RSA", * keySize: 2048, * keyOpts: [ * "decrypt", * "encrypt", * "sign", * "unwrapKey", * "verify", * "wrapKey", * ], * }, { * dependsOn: [ * exampleKeyVault, * exampleAccessPolicy, * ], * }); * const exampleWorkspace = new azure.machinelearning.Workspace("example", { * name: "example-workspace", * location: example.location, * resourceGroupName: example.name, * applicationInsightsId: exampleInsights.id, * keyVaultId: exampleKeyVault.id, * storageAccountId: exampleAccount.id, * identity: { * type: "SystemAssigned", * }, * encryption: { * keyVaultId: exampleKeyVault.id, * keyId: exampleKey.id, * }, * }); * ``` * * ## Import * * Machine Learning Workspace can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:machinelearning/workspace:Workspace example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.MachineLearningServices/workspaces/workspace1 * ``` */ 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 state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: WorkspaceState, 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 ID of the Application Insights associated with this Machine Learning Workspace. Changing this forces a new resource to be created. */ readonly applicationInsightsId: pulumi.Output; /** * The ID of the container registry associated with this Machine Learning Workspace. Changing this forces a new resource to be created. * * > **Note:** The `adminEnabled` should be `true` in order to associate the Container Registry to this Machine Learning Workspace. */ readonly containerRegistryId: pulumi.Output; /** * The description of this Machine Learning Workspace. */ readonly description: pulumi.Output; /** * The url for the discovery service to identify regional endpoints for machine learning experimentation services. */ readonly discoveryUrl: pulumi.Output; /** * An `encryption` block as defined below. Changing this forces a new resource to be created. */ readonly encryption: pulumi.Output; /** * A `featureStore` block as defined below. */ readonly featureStore: pulumi.Output; /** * Display name for this Machine Learning Workspace. */ readonly friendlyName: pulumi.Output; /** * Flag to signal High Business Impact (HBI) data in the workspace and reduce diagnostic data collected by the service. Changing this forces a new resource to be created. */ readonly highBusinessImpact: pulumi.Output; /** * An `identity` block as defined below. */ readonly identity: pulumi.Output; /** * The compute name for image build of the Machine Learning Workspace. */ readonly imageBuildComputeName: pulumi.Output; /** * The ID of key vault associated with this Machine Learning Workspace. Changing this forces a new resource to be created. */ readonly keyVaultId: pulumi.Output; /** * The type of the Workspace. Possible values are `Default`, `FeatureStore`. Defaults to `Default` */ readonly kind: pulumi.Output; /** * Specifies the supported Azure location where the Machine Learning Workspace should exist. Changing this forces a new resource to be created. */ readonly location: pulumi.Output; /** * A `managedNetwork` block as defined below. */ readonly managedNetwork: pulumi.Output; /** * Specifies the name of the Machine Learning Workspace. Changing this forces a new resource to be created. */ readonly name: pulumi.Output; /** * The user assigned identity id that represents the workspace identity. */ readonly primaryUserAssignedIdentity: pulumi.Output; /** * Enable public access when this Machine Learning Workspace is behind VNet. Defaults to `true`. * * > **Note:** `publicAccessBehindVirtualNetworkEnabled` is deprecated and will be removed in favour of the property `publicNetworkAccessEnabled`. */ readonly publicNetworkAccessEnabled: pulumi.Output; /** * Specifies the name of the Resource Group in which the Machine Learning Workspace should exist. Changing this forces a new resource to be created. */ readonly resourceGroupName: pulumi.Output; /** * A `serverlessCompute` block as defined below. */ readonly serverlessCompute: pulumi.Output; /** * Whether to enable service-side encryption with customer-managed keys (CMK). Default to `false`. Changing this forces a new resource to be created. * * !> **Note:** Setting `serviceSideEncryptionEnabled` requires the `encryption` block to be set. When you use service-side encryption, Azure charges will continue to accrue during the soft delete retention period. */ readonly serviceSideEncryptionEnabled: pulumi.Output; /** * SKU/edition of the Machine Learning Workspace, possible values are `Free`, `Basic`, `Standard` and `Premium`. Defaults to `Basic`. */ readonly skuName: pulumi.Output; /** * The ID of the Storage Account associated with this Machine Learning Workspace. Changing this forces a new resource to be created. * * > **Note:** The `accountTier` cannot be `Premium` in order to associate the Storage Account to this Machine Learning Workspace. */ readonly storageAccountId: pulumi.Output; /** * A mapping of tags to assign to the resource. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Enable V1 API features, enabling `v1LegacyMode` may prevent you from using features provided by the v2 API. Defaults to `false`. */ readonly v1LegacyModeEnabled: pulumi.Output; /** * The immutable id associated with this workspace. */ readonly workspaceId: pulumi.Output; /** * 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); } /** * Input properties used for looking up and filtering Workspace resources. */ export interface WorkspaceState { /** * The ID of the Application Insights associated with this Machine Learning Workspace. Changing this forces a new resource to be created. */ applicationInsightsId?: pulumi.Input; /** * The ID of the container registry associated with this Machine Learning Workspace. Changing this forces a new resource to be created. * * > **Note:** The `adminEnabled` should be `true` in order to associate the Container Registry to this Machine Learning Workspace. */ containerRegistryId?: pulumi.Input; /** * The description of this Machine Learning Workspace. */ description?: pulumi.Input; /** * The url for the discovery service to identify regional endpoints for machine learning experimentation services. */ discoveryUrl?: pulumi.Input; /** * An `encryption` block as defined below. Changing this forces a new resource to be created. */ encryption?: pulumi.Input; /** * A `featureStore` block as defined below. */ featureStore?: pulumi.Input; /** * Display name for this Machine Learning Workspace. */ friendlyName?: pulumi.Input; /** * Flag to signal High Business Impact (HBI) data in the workspace and reduce diagnostic data collected by the service. Changing this forces a new resource to be created. */ highBusinessImpact?: pulumi.Input; /** * An `identity` block as defined below. */ identity?: pulumi.Input; /** * The compute name for image build of the Machine Learning Workspace. */ imageBuildComputeName?: pulumi.Input; /** * The ID of key vault associated with this Machine Learning Workspace. Changing this forces a new resource to be created. */ keyVaultId?: pulumi.Input; /** * The type of the Workspace. Possible values are `Default`, `FeatureStore`. Defaults to `Default` */ kind?: pulumi.Input; /** * Specifies the supported Azure location where the Machine Learning Workspace should exist. Changing this forces a new resource to be created. */ location?: pulumi.Input; /** * A `managedNetwork` block as defined below. */ managedNetwork?: pulumi.Input; /** * Specifies the name of the Machine Learning Workspace. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * The user assigned identity id that represents the workspace identity. */ primaryUserAssignedIdentity?: pulumi.Input; /** * Enable public access when this Machine Learning Workspace is behind VNet. Defaults to `true`. * * > **Note:** `publicAccessBehindVirtualNetworkEnabled` is deprecated and will be removed in favour of the property `publicNetworkAccessEnabled`. */ publicNetworkAccessEnabled?: pulumi.Input; /** * Specifies the name of the Resource Group in which the Machine Learning Workspace should exist. Changing this forces a new resource to be created. */ resourceGroupName?: pulumi.Input; /** * A `serverlessCompute` block as defined below. */ serverlessCompute?: pulumi.Input; /** * Whether to enable service-side encryption with customer-managed keys (CMK). Default to `false`. Changing this forces a new resource to be created. * * !> **Note:** Setting `serviceSideEncryptionEnabled` requires the `encryption` block to be set. When you use service-side encryption, Azure charges will continue to accrue during the soft delete retention period. */ serviceSideEncryptionEnabled?: pulumi.Input; /** * SKU/edition of the Machine Learning Workspace, possible values are `Free`, `Basic`, `Standard` and `Premium`. Defaults to `Basic`. */ skuName?: pulumi.Input; /** * The ID of the Storage Account associated with this Machine Learning Workspace. Changing this forces a new resource to be created. * * > **Note:** The `accountTier` cannot be `Premium` in order to associate the Storage Account to this Machine Learning Workspace. */ storageAccountId?: pulumi.Input; /** * A mapping of tags to assign to the resource. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Enable V1 API features, enabling `v1LegacyMode` may prevent you from using features provided by the v2 API. Defaults to `false`. */ v1LegacyModeEnabled?: pulumi.Input; /** * The immutable id associated with this workspace. */ workspaceId?: pulumi.Input; } /** * The set of arguments for constructing a Workspace resource. */ export interface WorkspaceArgs { /** * The ID of the Application Insights associated with this Machine Learning Workspace. Changing this forces a new resource to be created. */ applicationInsightsId: pulumi.Input; /** * The ID of the container registry associated with this Machine Learning Workspace. Changing this forces a new resource to be created. * * > **Note:** The `adminEnabled` should be `true` in order to associate the Container Registry to this Machine Learning Workspace. */ containerRegistryId?: pulumi.Input; /** * The description of this Machine Learning Workspace. */ description?: pulumi.Input; /** * An `encryption` block as defined below. Changing this forces a new resource to be created. */ encryption?: pulumi.Input; /** * A `featureStore` block as defined below. */ featureStore?: pulumi.Input; /** * Display name for this Machine Learning Workspace. */ friendlyName?: pulumi.Input; /** * Flag to signal High Business Impact (HBI) data in the workspace and reduce diagnostic data collected by the service. Changing this forces a new resource to be created. */ highBusinessImpact?: pulumi.Input; /** * An `identity` block as defined below. */ identity: pulumi.Input; /** * The compute name for image build of the Machine Learning Workspace. */ imageBuildComputeName?: pulumi.Input; /** * The ID of key vault associated with this Machine Learning Workspace. Changing this forces a new resource to be created. */ keyVaultId: pulumi.Input; /** * The type of the Workspace. Possible values are `Default`, `FeatureStore`. Defaults to `Default` */ kind?: pulumi.Input; /** * Specifies the supported Azure location where the Machine Learning Workspace should exist. Changing this forces a new resource to be created. */ location?: pulumi.Input; /** * A `managedNetwork` block as defined below. */ managedNetwork?: pulumi.Input; /** * Specifies the name of the Machine Learning Workspace. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * The user assigned identity id that represents the workspace identity. */ primaryUserAssignedIdentity?: pulumi.Input; /** * Enable public access when this Machine Learning Workspace is behind VNet. Defaults to `true`. * * > **Note:** `publicAccessBehindVirtualNetworkEnabled` is deprecated and will be removed in favour of the property `publicNetworkAccessEnabled`. */ publicNetworkAccessEnabled?: pulumi.Input; /** * Specifies the name of the Resource Group in which the Machine Learning Workspace should exist. Changing this forces a new resource to be created. */ resourceGroupName: pulumi.Input; /** * A `serverlessCompute` block as defined below. */ serverlessCompute?: pulumi.Input; /** * Whether to enable service-side encryption with customer-managed keys (CMK). Default to `false`. Changing this forces a new resource to be created. * * !> **Note:** Setting `serviceSideEncryptionEnabled` requires the `encryption` block to be set. When you use service-side encryption, Azure charges will continue to accrue during the soft delete retention period. */ serviceSideEncryptionEnabled?: pulumi.Input; /** * SKU/edition of the Machine Learning Workspace, possible values are `Free`, `Basic`, `Standard` and `Premium`. Defaults to `Basic`. */ skuName?: pulumi.Input; /** * The ID of the Storage Account associated with this Machine Learning Workspace. Changing this forces a new resource to be created. * * > **Note:** The `accountTier` cannot be `Premium` in order to associate the Storage Account to this Machine Learning Workspace. */ storageAccountId: pulumi.Input; /** * A mapping of tags to assign to the resource. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Enable V1 API features, enabling `v1LegacyMode` may prevent you from using features provided by the v2 API. Defaults to `false`. */ v1LegacyModeEnabled?: pulumi.Input; }