Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. cosmosdb
  5. getNotebookWorkspace
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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.cosmosdb.getNotebookWorkspace

Explore with Pulumi AI

azure-native logo
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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets the notebook workspace for a Cosmos DB account.

    Uses Azure REST API version 2024-11-15.

    Other available API versions: 2019-08-01, 2019-12-12, 2020-03-01, 2020-04-01, 2020-06-01-preview, 2020-09-01, 2021-01-15, 2021-03-01-preview, 2021-03-15, 2021-04-01-preview, 2021-04-15, 2021-05-15, 2021-06-15, 2021-07-01-preview, 2021-10-15, 2021-10-15-preview, 2021-11-15-preview, 2022-02-15-preview, 2022-05-15, 2022-05-15-preview, 2022-08-15, 2022-08-15-preview, 2022-11-15, 2022-11-15-preview, 2023-03-01-preview, 2023-03-15, 2023-03-15-preview, 2023-04-15, 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15, 2024-05-15-preview, 2024-08-15, 2024-09-01-preview, 2024-12-01-preview, 2025-04-15, 2025-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cosmosdb [ApiVersion]. See the version guide for details.

    Using getNotebookWorkspace

    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 getNotebookWorkspace(args: GetNotebookWorkspaceArgs, opts?: InvokeOptions): Promise<GetNotebookWorkspaceResult>
function getNotebookWorkspaceOutput(args: GetNotebookWorkspaceOutputArgs, opts?: InvokeOptions): Output<GetNotebookWorkspaceResult>
    def get_notebook_workspace(account_name: Optional[str] = None,
                           notebook_workspace_name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetNotebookWorkspaceResult
def get_notebook_workspace_output(account_name: Optional[pulumi.Input[str]] = None,
                           notebook_workspace_name: Optional[pulumi.Input[str]] = None,
                           resource_group_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetNotebookWorkspaceResult]
    func LookupNotebookWorkspace(ctx *Context, args *LookupNotebookWorkspaceArgs, opts ...InvokeOption) (*LookupNotebookWorkspaceResult, error)
func LookupNotebookWorkspaceOutput(ctx *Context, args *LookupNotebookWorkspaceOutputArgs, opts ...InvokeOption) LookupNotebookWorkspaceResultOutput

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

    public static class GetNotebookWorkspace 
{
    public static Task<GetNotebookWorkspaceResult> InvokeAsync(GetNotebookWorkspaceArgs args, InvokeOptions? opts = null)
    public static Output<GetNotebookWorkspaceResult> Invoke(GetNotebookWorkspaceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNotebookWorkspaceResult> getNotebookWorkspace(GetNotebookWorkspaceArgs args, InvokeOptions options)
public static Output<GetNotebookWorkspaceResult> getNotebookWorkspace(GetNotebookWorkspaceArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:cosmosdb:getNotebookWorkspace
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AccountName string
    Cosmos DB database account name.
    NotebookWorkspaceName string
    The name of the notebook workspace resource.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AccountName string
    Cosmos DB database account name.
    NotebookWorkspaceName string
    The name of the notebook workspace resource.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    accountName String
    Cosmos DB database account name.
    notebookWorkspaceName String
    The name of the notebook workspace resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    accountName string
    Cosmos DB database account name.
    notebookWorkspaceName string
    The name of the notebook workspace resource.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    account_name str
    Cosmos DB database account name.
    notebook_workspace_name str
    The name of the notebook workspace resource.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    accountName String
    Cosmos DB database account name.
    notebookWorkspaceName String
    The name of the notebook workspace resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getNotebookWorkspace Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The unique resource identifier of the database account.
    Name string
    The name of the database account.
    NotebookServerEndpoint string
    Specifies the endpoint of Notebook server.
    Status string
    Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.
    Type string
    The type of Azure resource.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The unique resource identifier of the database account.
    Name string
    The name of the database account.
    NotebookServerEndpoint string
    Specifies the endpoint of Notebook server.
    Status string
    Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.
    Type string
    The type of Azure resource.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The unique resource identifier of the database account.
    name String
    The name of the database account.
    notebookServerEndpoint String
    Specifies the endpoint of Notebook server.
    status String
    Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.
    type String
    The type of Azure resource.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The unique resource identifier of the database account.
    name string
    The name of the database account.
    notebookServerEndpoint string
    Specifies the endpoint of Notebook server.
    status string
    Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.
    type string
    The type of Azure resource.
    azure_api_version str
    The Azure API version of the resource.
    id str
    The unique resource identifier of the database account.
    name str
    The name of the database account.
    notebook_server_endpoint str
    Specifies the endpoint of Notebook server.
    status str
    Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.
    type str
    The type of Azure resource.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The unique resource identifier of the database account.
    name String
    The name of the database account.
    notebookServerEndpoint String
    Specifies the endpoint of Notebook server.
    status String
    Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.
    type String
    The type of Azure resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native