@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 9.07 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets the properties of the specified machine learning workspace.
*
* Uses Azure REST API version 2025-09-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, 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 function getWorkspace(args: GetWorkspaceArgs, opts?: pulumi.InvokeOptions): Promise<GetWorkspaceResult>;
export interface GetWorkspaceArgs {
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
/**
* Name of Azure Machine Learning workspace.
*/
workspaceName: string;
}
/**
* An object that represents a machine learning workspace.
*/
export interface GetWorkspaceResult {
/**
* The flag to indicate whether to allow public access when behind VNet.
*/
readonly allowPublicAccessWhenBehindVnet?: boolean;
/**
* ARM id of the application insights associated with this workspace.
*/
readonly applicationInsights?: string;
readonly associatedWorkspaces?: string[];
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* ARM id of the container registry associated with this workspace.
*/
readonly containerRegistry?: string;
/**
* The description of this workspace.
*/
readonly description?: string;
/**
* Url for the discovery service to identify regional endpoints for machine learning experimentation services
*/
readonly discoveryUrl?: string;
readonly enableDataIsolation?: boolean;
readonly enableServiceSideCMKEncryption?: boolean;
/**
* The encryption settings of Azure ML workspace.
*/
readonly encryption?: outputs.machinelearningservices.EncryptionPropertyResponse;
/**
* Settings for feature store type workspace.
*/
readonly featureStoreSettings?: outputs.machinelearningservices.FeatureStoreSettingsResponse;
/**
* The friendly name for this workspace. This name in mutable
*/
readonly friendlyName?: string;
/**
* The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service
*/
readonly hbiWorkspace?: boolean;
readonly hubResourceId?: string;
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
readonly id: string;
/**
* The identity of the resource.
*/
readonly identity?: outputs.machinelearningservices.ManagedServiceIdentityResponse;
/**
* The compute name for image build
*/
readonly imageBuildCompute?: string;
/**
* ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created
*/
readonly keyVault?: string;
readonly kind?: string;
/**
* Specifies the location of the resource.
*/
readonly location?: string;
/**
* Managed Network settings for a machine learning workspace.
*/
readonly managedNetwork?: outputs.machinelearningservices.ManagedNetworkSettingsResponse;
/**
* The URI associated with this workspace that machine learning flow must point at to set up tracking.
*/
readonly mlFlowTrackingUri: string;
/**
* The name of the resource
*/
readonly name: string;
/**
* The notebook info of Azure ML workspace.
*/
readonly notebookInfo: outputs.machinelearningservices.NotebookResourceInfoResponse;
/**
* The user assigned identity resource id that represents the workspace identity.
*/
readonly primaryUserAssignedIdentity?: string;
/**
* The list of private endpoint connections in the workspace.
*/
readonly privateEndpointConnections: outputs.machinelearningservices.PrivateEndpointConnectionResponse[];
/**
* Count of private connections in the workspace
*/
readonly privateLinkCount: number;
/**
* Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing.
*/
readonly provisionNetworkNow?: boolean;
/**
* The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.
*/
readonly provisioningState: string;
/**
* Whether requests from Public Network are allowed.
*/
readonly publicNetworkAccess?: string;
/**
* Settings for serverless compute created in the workspace
*/
readonly serverlessComputeSettings?: outputs.machinelearningservices.ServerlessComputeSettingsResponse;
/**
* The service managed resource settings.
*/
readonly serviceManagedResourcesSettings?: outputs.machinelearningservices.ServiceManagedResourcesSettingsResponse;
/**
* The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace
*/
readonly serviceProvisionedResourceGroup: string;
/**
* The list of shared private link resources in this workspace.
*/
readonly sharedPrivateLinkResources?: outputs.machinelearningservices.SharedPrivateLinkResourceResponse[];
/**
* The sku of the workspace.
*/
readonly sku?: outputs.machinelearningservices.SkuResponse;
/**
* ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created
*/
readonly storageAccount?: string;
/**
* If the storage associated with the workspace has hierarchical namespace(HNS) enabled.
*/
readonly storageHnsEnabled: boolean;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.machinelearningservices.SystemDataResponse;
/**
* The auth mode used for accessing the system datastores of the workspace.
*/
readonly systemDatastoresAuthMode?: string;
/**
* Contains resource tags defined as key/value pairs.
*/
readonly tags?: {
[key: string]: string;
};
/**
* The tenant id associated with this workspace.
*/
readonly tenantId: string;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
/**
* Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.
*/
readonly v1LegacyMode?: boolean;
/**
* WorkspaceHub's configuration object.
*/
readonly workspaceHubConfig?: outputs.machinelearningservices.WorkspaceHubConfigResponse;
/**
* The immutable id associated with this workspace.
*/
readonly workspaceId: string;
}
/**
* Gets the properties of the specified machine learning workspace.
*
* Uses Azure REST API version 2025-09-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, 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 function getWorkspaceOutput(args: GetWorkspaceOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetWorkspaceResult>;
export interface GetWorkspaceOutputArgs {
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Name of Azure Machine Learning workspace.
*/
workspaceName: pulumi.Input<string>;
}