DocumentdbFunctions

Functions

Link copied to clipboard

Get the properties of a managed Cassandra cluster. Uses Azure REST API version 2023-04-15. Other available API versions: 2021-07-01-preview, 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.

suspend fun getCassandraCluster(clusterName: String, resourceGroupName: String): GetCassandraClusterResult
Link copied to clipboard

Get the properties of a managed Cassandra data center. Uses 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.

suspend fun getCassandraDataCenter(clusterName: String, dataCenterName: String, resourceGroupName: String): GetCassandraDataCenterResult
Link copied to clipboard

Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name. Uses Azure REST API version 2023-04-15. Other available API versions: 2023-03-15-preview, 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.

suspend fun getCassandraResourceCassandraKeyspace(accountName: String, keyspaceName: String, resourceGroupName: String): GetCassandraResourceCassandraKeyspaceResult
Link copied to clipboard

Gets the Cassandra table under an existing Azure Cosmos DB database account. Uses Azure REST API version 2023-04-15. Other available API versions: 2023-03-15-preview, 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.

suspend fun getCassandraResourceCassandraTable(accountName: String, keyspaceName: String, resourceGroupName: String, tableName: String): GetCassandraResourceCassandraTableResult
Link copied to clipboard

Gets the Cassandra view under an existing Azure Cosmos DB database account. Uses Azure REST API version 2023-03-15-preview. Other available API versions: 2023-09-15-preview, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15-preview, 2024-09-01-preview, 2024-12-01-preview.

suspend fun getCassandraResourceCassandraView(accountName: String, keyspaceName: String, resourceGroupName: String, viewName: String): GetCassandraResourceCassandraViewResult
Link copied to clipboard

Retrieves the properties of an existing Azure Cosmos DB database account. Uses Azure REST API version 2023-04-15. Other available API versions: 2021-04-01-preview, 2023-03-15-preview, 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.

suspend fun getDatabaseAccount(accountName: String, resourceGroupName: String): GetDatabaseAccountResult
Link copied to clipboard

Gets information about a mongo cluster firewall rule. Uses Azure REST API version 2024-03-01-preview. Other available API versions: 2024-06-01-preview, 2024-07-01, 2024-10-01-preview.

suspend fun getFirewallRule(firewallRuleName: String, mongoClusterName: String, resourceGroupName: String): GetFirewallRuleResult
Link copied to clipboard

Gets the Graph resource under an existing Azure Cosmos DB database account with the provided name. Uses Azure REST API version 2023-03-15-preview. Other available API versions: 2023-09-15-preview, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15-preview, 2024-09-01-preview, 2024-12-01-preview.

suspend fun getGraphResourceGraph(accountName: String, graphName: String, resourceGroupName: String): GetGraphResourceGraphResult
Link copied to clipboard

Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name. Uses Azure REST API version 2023-04-15. Other available API versions: 2023-03-15-preview, 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.

suspend fun getGremlinResourceGremlinDatabase(accountName: String, databaseName: String, resourceGroupName: String): GetGremlinResourceGremlinDatabaseResult
Link copied to clipboard

Gets the Gremlin graph under an existing Azure Cosmos DB database account. Uses Azure REST API version 2023-04-15. Other available API versions: 2023-03-15-preview, 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.

suspend fun getGremlinResourceGremlinGraph(accountName: String, databaseName: String, graphName: String, resourceGroupName: String): GetGremlinResourceGremlinGraphResult
Link copied to clipboard

Gets information about a mongo cluster. Uses Azure REST API version 2023-03-15-preview. Other available API versions: 2023-09-15-preview, 2023-11-15-preview, 2024-02-15-preview, 2024-03-01-preview, 2024-06-01-preview, 2024-07-01, 2024-10-01-preview.

suspend fun getMongoCluster(mongoClusterName: String, resourceGroupName: String): GetMongoClusterResult
Link copied to clipboard

Gets information about a mongo cluster firewall rule. Uses Azure REST API version 2023-03-15-preview. Other available API versions: 2023-09-15-preview, 2023-11-15-preview, 2024-02-15-preview.

suspend fun getMongoClusterFirewallRule(firewallRuleName: String, mongoClusterName: String, resourceGroupName: String): GetMongoClusterFirewallRuleResult
Link copied to clipboard

Gets the MongoDB collection under an existing Azure Cosmos DB database account. Uses Azure REST API version 2023-04-15. Other available API versions: 2023-03-15-preview, 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.

suspend fun getMongoDBResourceMongoDBCollection(accountName: String, collectionName: String, databaseName: String, resourceGroupName: String): GetMongoDBResourceMongoDBCollectionResult
Link copied to clipboard

Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name. Uses Azure REST API version 2023-04-15. Other available API versions: 2023-03-15-preview, 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.

suspend fun getMongoDBResourceMongoDBDatabase(accountName: String, databaseName: String, resourceGroupName: String): GetMongoDBResourceMongoDBDatabaseResult
Link copied to clipboard

Retrieves the properties of an existing Azure Cosmos DB Mongo Role Definition with the given Id. Uses Azure REST API version 2023-04-15. Other available API versions: 2023-03-01-preview, 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.

suspend fun getMongoDBResourceMongoRoleDefinition(accountName: String, mongoRoleDefinitionId: String, resourceGroupName: String): GetMongoDBResourceMongoRoleDefinitionResult
Link copied to clipboard

Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id. Uses 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.

suspend fun getMongoDBResourceMongoUserDefinition(accountName: String, mongoUserDefinitionId: String, resourceGroupName: String): GetMongoDBResourceMongoUserDefinitionResult
Link copied to clipboard

Gets the notebook workspace for a Cosmos DB account. Uses 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.

suspend fun getNotebookWorkspace(accountName: String, notebookWorkspaceName: String, resourceGroupName: String): GetNotebookWorkspaceResult
Link copied to clipboard

Gets a private endpoint connection. Uses 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-03-01-preview, 2024-05-15, 2024-05-15-preview, 2024-06-01-preview, 2024-07-01, 2024-08-15, 2024-09-01-preview, 2024-10-01-preview, 2024-11-15, 2024-12-01-preview.

suspend fun getPrivateEndpointConnection(accountName: String, privateEndpointConnectionName: String, resourceGroupName: String): GetPrivateEndpointConnectionResult
Link copied to clipboard

Gets the status of service. Uses 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.

suspend fun getService(argument: suspend GetServicePlainArgsBuilder.() -> Unit): GetServiceResult
suspend fun getService(accountName: String, resourceGroupName: String, serviceName: String): GetServiceResult
Link copied to clipboard

Gets the SQL container under an existing Azure Cosmos DB database account. Uses Azure REST API version 2023-04-15. Other available API versions: 2023-03-15-preview, 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.

suspend fun getSqlResourceSqlContainer(accountName: String, containerName: String, databaseName: String, resourceGroupName: String): GetSqlResourceSqlContainerResult
Link copied to clipboard

Gets the SQL database under an existing Azure Cosmos DB database account with the provided name. Uses Azure REST API version 2023-04-15. Other available API versions: 2023-03-15-preview, 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.

suspend fun getSqlResourceSqlDatabase(accountName: String, databaseName: String, resourceGroupName: String): GetSqlResourceSqlDatabaseResult
Link copied to clipboard

Retrieves the properties of an existing Azure Cosmos DB SQL Role Assignment with the given Id. Uses 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.

suspend fun getSqlResourceSqlRoleAssignment(accountName: String, resourceGroupName: String, roleAssignmentId: String): GetSqlResourceSqlRoleAssignmentResult
Link copied to clipboard

Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id. Uses 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.

suspend fun getSqlResourceSqlRoleDefinition(accountName: String, resourceGroupName: String, roleDefinitionId: String): GetSqlResourceSqlRoleDefinitionResult
Link copied to clipboard

Gets the SQL storedProcedure under an existing Azure Cosmos DB database account. Uses Azure REST API version 2023-04-15. Other available API versions: 2023-03-15-preview, 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.

suspend fun getSqlResourceSqlStoredProcedure(accountName: String, containerName: String, databaseName: String, resourceGroupName: String, storedProcedureName: String): GetSqlResourceSqlStoredProcedureResult
Link copied to clipboard

Gets the SQL trigger under an existing Azure Cosmos DB database account. Uses Azure REST API version 2023-04-15. Other available API versions: 2023-03-15-preview, 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.

suspend fun getSqlResourceSqlTrigger(accountName: String, containerName: String, databaseName: String, resourceGroupName: String, triggerName: String): GetSqlResourceSqlTriggerResult
Link copied to clipboard

Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account. Uses Azure REST API version 2023-04-15. Other available API versions: 2023-03-15-preview, 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.

suspend fun getSqlResourceSqlUserDefinedFunction(accountName: String, containerName: String, databaseName: String, resourceGroupName: String, userDefinedFunctionName: String): GetSqlResourceSqlUserDefinedFunctionResult
Link copied to clipboard

Gets the Tables under an existing Azure Cosmos DB database account with the provided name. Uses Azure REST API version 2023-04-15. Other available API versions: 2023-03-15-preview, 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.

suspend fun getTableResourceTable(accountName: String, resourceGroupName: String, tableName: String): GetTableResourceTableResult
Link copied to clipboard

Retrieves the properties of an existing Azure Cosmos DB Table Role Assignment with the given Id. Uses Azure REST API version 2024-12-01-preview.

suspend fun getTableResourceTableRoleAssignment(accountName: String, resourceGroupName: String, roleAssignmentId: String): GetTableResourceTableRoleAssignmentResult
Link copied to clipboard

Retrieves the properties of an existing Azure Cosmos DB Table Role Definition with the given Id. Uses Azure REST API version 2024-12-01-preview.

suspend fun getTableResourceTableRoleDefinition(accountName: String, resourceGroupName: String, roleDefinitionId: String): GetTableResourceTableRoleDefinitionResult
Link copied to clipboard

Retrieves the properties of an existing Azure Cosmos DB Throughput Pool Uses Azure REST API version 2023-11-15-preview. Other available API versions: 2024-02-15-preview, 2024-05-15-preview, 2024-09-01-preview, 2024-12-01-preview.

suspend fun getThroughputPool(resourceGroupName: String, throughputPoolName: String): GetThroughputPoolResult
Link copied to clipboard

Retrieves the properties of an existing Azure Cosmos DB Throughput Pool Uses Azure REST API version 2023-11-15-preview. Other available API versions: 2024-02-15-preview, 2024-05-15-preview, 2024-09-01-preview, 2024-12-01-preview.

suspend fun getThroughputPoolAccount(resourceGroupName: String, throughputPoolAccountName: String, throughputPoolName: String): GetThroughputPoolAccountResult
Link copied to clipboard

Lists the connection strings for the specified Azure Cosmos DB database account. Uses Azure REST API version 2023-04-15. Other available API versions: 2021-04-01-preview, 2023-03-15-preview, 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.

Link copied to clipboard

Lists the access keys for the specified Azure Cosmos DB database account. Uses Azure REST API version 2023-04-15. Other available API versions: 2021-04-01-preview, 2023-03-15-preview, 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.

suspend fun listDatabaseAccountKeys(accountName: String, resourceGroupName: String): ListDatabaseAccountKeysResult
Link copied to clipboard

List mongo cluster connection strings. This includes the default connection string using SCRAM-SHA-256, as well as other connection strings supported by the cluster. Uses Azure REST API version 2023-03-15-preview. Other available API versions: 2023-09-15-preview, 2023-11-15-preview, 2024-02-15-preview, 2024-03-01-preview, 2024-06-01-preview, 2024-07-01, 2024-10-01-preview.

Link copied to clipboard

Retrieves the connection info for the notebook workspace Uses 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.

suspend fun listNotebookWorkspaceConnectionInfo(accountName: String, notebookWorkspaceName: String, resourceGroupName: String): ListNotebookWorkspaceConnectionInfoResult