@pulumi/azure-native/synapse/getWorkspace.d.ts

[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [![Python version](https://badge.fury.io/py/pu

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Gets a workspace
 *
 * Uses Azure REST API version 2021-06-01.
 *
 * Other available API versions: 2021-04-01-preview, 2021-05-01, 2021-06-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native synapse [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;
    /**
     * The name of the workspace.
     */
    workspaceName: string;
}
/**
 * A workspace
 */
export interface GetWorkspaceResult {
    /**
     * The ADLA resource ID.
     */
    readonly adlaResourceId: string;
    /**
     * The Azure API version of the resource.
     */
    readonly azureApiVersion: string;
    /**
     * Connectivity endpoints
     */
    readonly connectivityEndpoints: {
        [key: string]: string;
    };
    /**
     * Initial workspace AAD admin properties for a CSP subscription
     */
    readonly cspWorkspaceAdminProperties?: outputs.synapse.CspWorkspaceAdminPropertiesResponse;
    /**
     * Workspace default data lake storage account details
     */
    readonly defaultDataLakeStorage?: outputs.synapse.DataLakeStorageAccountDetailsResponse;
    /**
     * The encryption details of the workspace
     */
    readonly encryption?: outputs.synapse.EncryptionDetailsResponse;
    /**
     * Workspace level configs and feature flags
     */
    readonly extraProperties: any;
    /**
     * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
     */
    readonly id: string;
    /**
     * Identity of the workspace
     */
    readonly identity?: outputs.synapse.ManagedIdentityResponse;
    /**
     * The geo-location where the resource lives
     */
    readonly location: string;
    /**
     * Workspace managed resource group. The resource group name uniquely identifies the resource group within the user subscriptionId. The resource group name must be no longer than 90 characters long, and must be alphanumeric characters (Char.IsLetterOrDigit()) and '-', '_', '(', ')' and'.'. Note that the name cannot end with '.'
     */
    readonly managedResourceGroupName?: string;
    /**
     * Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.
     */
    readonly managedVirtualNetwork?: string;
    /**
     * Managed Virtual Network Settings
     */
    readonly managedVirtualNetworkSettings?: outputs.synapse.ManagedVirtualNetworkSettingsResponse;
    /**
     * The name of the resource
     */
    readonly name: string;
    /**
     * Private endpoint connections to the workspace
     */
    readonly privateEndpointConnections?: outputs.synapse.PrivateEndpointConnectionResponse[];
    /**
     * Resource provisioning state
     */
    readonly provisioningState: string;
    /**
     * Enable or Disable public network access to workspace
     */
    readonly publicNetworkAccess?: string;
    /**
     * Purview Configuration
     */
    readonly purviewConfiguration?: outputs.synapse.PurviewConfigurationResponse;
    /**
     * Workspace settings
     */
    readonly settings: {
        [key: string]: any;
    };
    /**
     * Login for workspace SQL active directory administrator
     */
    readonly sqlAdministratorLogin?: string;
    /**
     * SQL administrator login password
     */
    readonly sqlAdministratorLoginPassword?: string;
    /**
     * Resource tags.
     */
    readonly tags?: {
        [key: string]: string;
    };
    /**
     * Is trustedServiceBypassEnabled for the workspace
     */
    readonly trustedServiceBypassEnabled?: boolean;
    /**
     * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
     */
    readonly type: string;
    /**
     * Virtual Network profile
     */
    readonly virtualNetworkProfile?: outputs.synapse.VirtualNetworkProfileResponse;
    /**
     * Git integration settings
     */
    readonly workspaceRepositoryConfiguration?: outputs.synapse.WorkspaceRepositoryConfigurationResponse;
    /**
     * The workspace unique identifier
     */
    readonly workspaceUID: string;
}
/**
 * Gets a workspace
 *
 * Uses Azure REST API version 2021-06-01.
 *
 * Other available API versions: 2021-04-01-preview, 2021-05-01, 2021-06-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native synapse [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>;
    /**
     * The name of the workspace.
     */
    workspaceName: pulumi.Input<string>;
}