Notebook Workspaces - List Connection Info

サービス:

Cosmos DB Resource Provider

API バージョン:

2024-11-15

ノートブック ワークスペースの接続情報を取得します

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/default/listConnectionInfo?api-version=2024-11-15

URI パラメーター

名前	/	必須	型	説明
accountName	path	True	string	Cosmos DB データベース アカウント名。 正規表現パターン: ^[a-z0-9]+(-[a-z0-9]+)*
notebookWorkspaceName	path	True	NotebookWorkspaceName	ノートブック ワークスペース リソースの名前。
resourceGroupName	path	True	string	リソース グループの名前。 名前では大文字と小文字が区別されません。
subscriptionId	path	True	string	ターゲット サブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	NotebookWorkspaceConnectionInfoResult	操作が正常に完了しました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

CosmosDBNotebookWorkspaceListConnectionInfo

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/notebookWorkspaces/default/listConnectionInfo?api-version=2024-11-15

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_notebook_workspace_list_connection_info.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.notebook_workspaces.list_connection_info(
        resource_group_name="rg1",
        account_name="ddb1",
        notebook_workspace_name="default",
    )
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBNotebookWorkspaceListConnectionInfo.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

200

{
  "authToken": "auth-token",
  "notebookServerEndpoint": "notebook endpoint"
}

定義

名前	説明
ErrorResponse	エラー応答。
NotebookWorkspaceConnectionInfoResult	特定のノートブック ワークスペースの接続情報
NotebookWorkspaceName	ノートブック ワークスペース リソースの名前。

ErrorResponse

エラー応答。

名前	型	説明
code	string	エラー コード。
message	string	操作が失敗した理由を示すエラー メッセージ。

NotebookWorkspaceConnectionInfoResult

特定のノートブック ワークスペースの接続情報

名前	型	説明
authToken	string	Notebook サーバーへの接続に使用される認証トークンを指定します (トークンベースの認証を使用します)。
notebookServerEndpoint	string	Notebook サーバーのエンドポイントを指定します。

NotebookWorkspaceName

ノートブック ワークスペース リソースの名前。

名前	型	説明
default	string