Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. documentdb
  5. listNotebookWorkspaceConnectionInfo
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.documentdb.listNotebookWorkspaceConnectionInfo

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Retrieves the connection info for the notebook workspace Azure REST API version: 2023-04-15.

Other available API versions: 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-11-15, 2024-12-01-preview.

Using listNotebookWorkspaceConnectionInfo

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 listNotebookWorkspaceConnectionInfo(args: ListNotebookWorkspaceConnectionInfoArgs, opts?: InvokeOptions): Promise<ListNotebookWorkspaceConnectionInfoResult>
function listNotebookWorkspaceConnectionInfoOutput(args: ListNotebookWorkspaceConnectionInfoOutputArgs, opts?: InvokeOptions): Output<ListNotebookWorkspaceConnectionInfoResult>
Copy
def list_notebook_workspace_connection_info(account_name: Optional[str] = None,
                                            notebook_workspace_name: Optional[str] = None,
                                            resource_group_name: Optional[str] = None,
                                            opts: Optional[InvokeOptions] = None) -> ListNotebookWorkspaceConnectionInfoResult
def list_notebook_workspace_connection_info_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[ListNotebookWorkspaceConnectionInfoResult]
Copy
func ListNotebookWorkspaceConnectionInfo(ctx *Context, args *ListNotebookWorkspaceConnectionInfoArgs, opts ...InvokeOption) (*ListNotebookWorkspaceConnectionInfoResult, error)
func ListNotebookWorkspaceConnectionInfoOutput(ctx *Context, args *ListNotebookWorkspaceConnectionInfoOutputArgs, opts ...InvokeOption) ListNotebookWorkspaceConnectionInfoResultOutput
Copy

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

public static class ListNotebookWorkspaceConnectionInfo 
{
    public static Task<ListNotebookWorkspaceConnectionInfoResult> InvokeAsync(ListNotebookWorkspaceConnectionInfoArgs args, InvokeOptions? opts = null)
    public static Output<ListNotebookWorkspaceConnectionInfoResult> Invoke(ListNotebookWorkspaceConnectionInfoInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListNotebookWorkspaceConnectionInfoResult> listNotebookWorkspaceConnectionInfo(ListNotebookWorkspaceConnectionInfoArgs args, InvokeOptions options)
public static Output<ListNotebookWorkspaceConnectionInfoResult> listNotebookWorkspaceConnectionInfo(ListNotebookWorkspaceConnectionInfoArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:documentdb:listNotebookWorkspaceConnectionInfo
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
NotebookWorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the notebook workspace resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
NotebookWorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the notebook workspace resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
notebookWorkspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the notebook workspace resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
notebookWorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the notebook workspace resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
account_name
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB database account name.
notebook_workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the notebook workspace resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
notebookWorkspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the notebook workspace resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

listNotebookWorkspaceConnectionInfo Result

The following output properties are available:

AuthToken string
Specifies auth token used for connecting to Notebook server (uses token-based auth).
NotebookServerEndpoint string
Specifies the endpoint of Notebook server.
AuthToken string
Specifies auth token used for connecting to Notebook server (uses token-based auth).
NotebookServerEndpoint string
Specifies the endpoint of Notebook server.
authToken String
Specifies auth token used for connecting to Notebook server (uses token-based auth).
notebookServerEndpoint String
Specifies the endpoint of Notebook server.
authToken string
Specifies auth token used for connecting to Notebook server (uses token-based auth).
notebookServerEndpoint string
Specifies the endpoint of Notebook server.
auth_token str
Specifies auth token used for connecting to Notebook server (uses token-based auth).
notebook_server_endpoint str
Specifies the endpoint of Notebook server.
authToken String
Specifies auth token used for connecting to Notebook server (uses token-based auth).
notebookServerEndpoint String
Specifies the endpoint of Notebook server.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native