Notebook Workspaces - List Connection Info

Tjänst:

Cosmos DB Resource Provider

API-version:

2024-11-15

Hämtar anslutningsinformationen för notebook-arbetsytan

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
accountName	path	True	string	Cosmos DB-databaskontonamn. Reguljärt uttrycksmönster: ^[a-z0-9]+(-[a-z0-9]+)*
notebookWorkspaceName	path	True	NotebookWorkspaceName	Namnet på resursen för notebook-arbetsytan.
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	NotebookWorkspaceConnectionInfoResult	Åtgärden har slutförts.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	Personifiera ditt användarkonto

Exempel

CosmosDBNotebookWorkspaceListConnectionInfo

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
ErrorResponse	Felsvar.
NotebookWorkspaceConnectionInfoResult	Anslutningsinformationen för den angivna notebook-arbetsytan
NotebookWorkspaceName	Namnet på resursen för notebook-arbetsytan.

ErrorResponse

Felsvar.

Name	Typ	Description
code	string	Felkod.
message	string	Felmeddelande som anger varför åtgärden misslyckades.

NotebookWorkspaceConnectionInfoResult

Anslutningsinformationen för den angivna notebook-arbetsytan

Name	Typ	Description
authToken	string	Anger autentiseringstoken som används för att ansluta till Notebook-servern (använder tokenbaserad autentisering).
notebookServerEndpoint	string	Anger slutpunkten för Notebook-servern.

NotebookWorkspaceName

Namnet på resursen för notebook-arbetsytan.

Name	Typ	Description
default	string