pulumi-azure-native-kotlin/com.pulumi.azurenative.documentdb.kotlin/DocumentdbFunctions

DocumentdbFunctions

object DocumentdbFunctions

Functions

Link copied to clipboard
suspend fun getCassandraCluster(argument: GetCassandraClusterPlainArgs): GetCassandraClusterResult

Get the properties of a managed Cassandra cluster. Azure REST API version: 2023-04-15. Other available API versions: 2021-07-01-preview, 2023-09-15, 2023-09-15-preview.

suspend fun getCassandraCluster(argument: suspend GetCassandraClusterPlainArgsBuilder.() -> Unit): GetCassandraClusterResult
suspend fun getCassandraCluster(clusterName: String, resourceGroupName: String): GetCassandraClusterResult
Link copied to clipboard
suspend fun getCassandraDataCenter(argument: GetCassandraDataCenterPlainArgs): GetCassandraDataCenterResult

Get the properties of a managed Cassandra data center. Azure REST API version: 2023-04-15. Other available API versions: 2023-09-15, 2023-09-15-preview.

suspend fun getCassandraDataCenter(argument: suspend GetCassandraDataCenterPlainArgsBuilder.() -> Unit): GetCassandraDataCenterResult
suspend fun getCassandraDataCenter(clusterName: String, dataCenterName: String, resourceGroupName: String): GetCassandraDataCenterResult
Link copied to clipboard
suspend fun getCassandraResourceCassandraKeyspace(argument: GetCassandraResourceCassandraKeyspacePlainArgs): GetCassandraResourceCassandraKeyspaceResult

Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name. Azure REST API version: 2023-04-15. Other available API versions: 2019-08-01, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview.

suspend fun getCassandraResourceCassandraKeyspace(argument: suspend GetCassandraResourceCassandraKeyspacePlainArgsBuilder.() -> Unit): GetCassandraResourceCassandraKeyspaceResult
suspend fun getCassandraResourceCassandraKeyspace(accountName: String, keyspaceName: String, resourceGroupName: String): GetCassandraResourceCassandraKeyspaceResult
Link copied to clipboard
suspend fun getCassandraResourceCassandraTable(argument: GetCassandraResourceCassandraTablePlainArgs): GetCassandraResourceCassandraTableResult

Gets the Cassandra table under an existing Azure Cosmos DB database account. Azure REST API version: 2023-04-15. Other available API versions: 2019-08-01, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview.

suspend fun getCassandraResourceCassandraTable(argument: suspend GetCassandraResourceCassandraTablePlainArgsBuilder.() -> Unit): GetCassandraResourceCassandraTableResult
suspend fun getCassandraResourceCassandraTable(accountName: String, keyspaceName: String, resourceGroupName: String, tableName: String): GetCassandraResourceCassandraTableResult
Link copied to clipboard
suspend fun getCassandraResourceCassandraView(argument: GetCassandraResourceCassandraViewPlainArgs): GetCassandraResourceCassandraViewResult

Gets the Cassandra view under an existing Azure Cosmos DB database account. Azure REST API version: 2023-03-15-preview. Other available API versions: 2023-09-15-preview.

suspend fun getCassandraResourceCassandraView(argument: suspend GetCassandraResourceCassandraViewPlainArgsBuilder.() -> Unit): GetCassandraResourceCassandraViewResult
suspend fun getCassandraResourceCassandraView(accountName: String, keyspaceName: String, resourceGroupName: String, viewName: String): GetCassandraResourceCassandraViewResult
Link copied to clipboard
suspend fun getDatabaseAccount(argument: GetDatabaseAccountPlainArgs): GetDatabaseAccountResult

Retrieves the properties of an existing Azure Cosmos DB database account. Azure REST API version: 2023-04-15. Other available API versions: 2020-03-01, 2020-06-01-preview, 2020-09-01, 2021-04-01-preview, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview.

suspend fun getDatabaseAccount(argument: suspend GetDatabaseAccountPlainArgsBuilder.() -> Unit): GetDatabaseAccountResult
suspend fun getDatabaseAccount(accountName: String, resourceGroupName: String): GetDatabaseAccountResult
Link copied to clipboard
suspend fun getGraphResourceGraph(argument: GetGraphResourceGraphPlainArgs): GetGraphResourceGraphResult

Gets the Graph resource under an existing Azure Cosmos DB database account with the provided name. Azure REST API version: 2023-03-15-preview. Other available API versions: 2023-09-15-preview.

suspend fun getGraphResourceGraph(argument: suspend GetGraphResourceGraphPlainArgsBuilder.() -> Unit): GetGraphResourceGraphResult
suspend fun getGraphResourceGraph(accountName: String, graphName: String, resourceGroupName: String): GetGraphResourceGraphResult
Link copied to clipboard
suspend fun getGremlinResourceGremlinDatabase(argument: GetGremlinResourceGremlinDatabasePlainArgs): GetGremlinResourceGremlinDatabaseResult

Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name. Azure REST API version: 2023-04-15. Other available API versions: 2019-08-01, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview.

suspend fun getGremlinResourceGremlinDatabase(argument: suspend GetGremlinResourceGremlinDatabasePlainArgsBuilder.() -> Unit): GetGremlinResourceGremlinDatabaseResult
suspend fun getGremlinResourceGremlinDatabase(accountName: String, databaseName: String, resourceGroupName: String): GetGremlinResourceGremlinDatabaseResult
Link copied to clipboard
suspend fun getGremlinResourceGremlinGraph(argument: GetGremlinResourceGremlinGraphPlainArgs): GetGremlinResourceGremlinGraphResult

Gets the Gremlin graph under an existing Azure Cosmos DB database account. Azure REST API version: 2023-04-15. Other available API versions: 2019-08-01, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview.

suspend fun getGremlinResourceGremlinGraph(argument: suspend GetGremlinResourceGremlinGraphPlainArgsBuilder.() -> Unit): GetGremlinResourceGremlinGraphResult
suspend fun getGremlinResourceGremlinGraph(accountName: String, databaseName: String, graphName: String, resourceGroupName: String): GetGremlinResourceGremlinGraphResult
Link copied to clipboard
suspend fun getMongoCluster(argument: GetMongoClusterPlainArgs): GetMongoClusterResult

Gets information about a mongo cluster. Azure REST API version: 2023-03-15-preview. Other available API versions: 2023-09-15-preview.

suspend fun getMongoCluster(argument: suspend GetMongoClusterPlainArgsBuilder.() -> Unit): GetMongoClusterResult
suspend fun getMongoCluster(mongoClusterName: String, resourceGroupName: String): GetMongoClusterResult
Link copied to clipboard
suspend fun getMongoClusterFirewallRule(argument: GetMongoClusterFirewallRulePlainArgs): GetMongoClusterFirewallRuleResult

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

suspend fun getMongoClusterFirewallRule(argument: suspend GetMongoClusterFirewallRulePlainArgsBuilder.() -> Unit): GetMongoClusterFirewallRuleResult
suspend fun getMongoClusterFirewallRule(firewallRuleName: String, mongoClusterName: String, resourceGroupName: String): GetMongoClusterFirewallRuleResult
Link copied to clipboard
suspend fun getMongoDBResourceMongoDBCollection(argument: GetMongoDBResourceMongoDBCollectionPlainArgs): GetMongoDBResourceMongoDBCollectionResult

Gets the MongoDB collection under an existing Azure Cosmos DB database account. Azure REST API version: 2023-04-15. Other available API versions: 2019-08-01, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview.

suspend fun getMongoDBResourceMongoDBCollection(argument: suspend GetMongoDBResourceMongoDBCollectionPlainArgsBuilder.() -> Unit): GetMongoDBResourceMongoDBCollectionResult
suspend fun getMongoDBResourceMongoDBCollection(accountName: String, collectionName: String, databaseName: String, resourceGroupName: String): GetMongoDBResourceMongoDBCollectionResult
Link copied to clipboard
suspend fun getMongoDBResourceMongoDBDatabase(argument: GetMongoDBResourceMongoDBDatabasePlainArgs): GetMongoDBResourceMongoDBDatabaseResult

Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name. Azure REST API version: 2023-04-15. Other available API versions: 2019-08-01, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview.

suspend fun getMongoDBResourceMongoDBDatabase(argument: suspend GetMongoDBResourceMongoDBDatabasePlainArgsBuilder.() -> Unit): GetMongoDBResourceMongoDBDatabaseResult
suspend fun getMongoDBResourceMongoDBDatabase(accountName: String, databaseName: String, resourceGroupName: String): GetMongoDBResourceMongoDBDatabaseResult
Link copied to clipboard
suspend fun getMongoDBResourceMongoRoleDefinition(argument: GetMongoDBResourceMongoRoleDefinitionPlainArgs): GetMongoDBResourceMongoRoleDefinitionResult

Retrieves the properties of an existing Azure Cosmos DB Mongo Role Definition with the given Id. Azure REST API version: 2023-04-15. Other available API versions: 2023-03-01-preview, 2023-09-15, 2023-09-15-preview.

suspend fun getMongoDBResourceMongoRoleDefinition(argument: suspend GetMongoDBResourceMongoRoleDefinitionPlainArgsBuilder.() -> Unit): GetMongoDBResourceMongoRoleDefinitionResult
suspend fun getMongoDBResourceMongoRoleDefinition(accountName: String, mongoRoleDefinitionId: String, resourceGroupName: String): GetMongoDBResourceMongoRoleDefinitionResult
Link copied to clipboard
suspend fun getMongoDBResourceMongoUserDefinition(argument: GetMongoDBResourceMongoUserDefinitionPlainArgs): GetMongoDBResourceMongoUserDefinitionResult

Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id. Azure REST API version: 2023-04-15. Other available API versions: 2023-09-15, 2023-09-15-preview.

suspend fun getMongoDBResourceMongoUserDefinition(argument: suspend GetMongoDBResourceMongoUserDefinitionPlainArgsBuilder.() -> Unit): GetMongoDBResourceMongoUserDefinitionResult
suspend fun getMongoDBResourceMongoUserDefinition(accountName: String, mongoUserDefinitionId: String, resourceGroupName: String): GetMongoDBResourceMongoUserDefinitionResult
Link copied to clipboard
suspend fun getNotebookWorkspace(argument: GetNotebookWorkspacePlainArgs): GetNotebookWorkspaceResult

Gets the notebook workspace for a Cosmos DB account. Azure REST API version: 2023-04-15. Other available API versions: 2023-09-15, 2023-09-15-preview.

suspend fun getNotebookWorkspace(argument: suspend GetNotebookWorkspacePlainArgsBuilder.() -> Unit): GetNotebookWorkspaceResult
suspend fun getNotebookWorkspace(accountName: String, notebookWorkspaceName: String, resourceGroupName: String): GetNotebookWorkspaceResult
Link copied to clipboard
suspend fun getPrivateEndpointConnection(argument: GetPrivateEndpointConnectionPlainArgs): GetPrivateEndpointConnectionResult

Gets a private endpoint connection. Azure REST API version: 2023-04-15. Other available API versions: 2023-09-15, 2023-09-15-preview.

suspend fun getPrivateEndpointConnection(argument: suspend GetPrivateEndpointConnectionPlainArgsBuilder.() -> Unit): GetPrivateEndpointConnectionResult
suspend fun getPrivateEndpointConnection(accountName: String, privateEndpointConnectionName: String, resourceGroupName: String): GetPrivateEndpointConnectionResult
Link copied to clipboard
suspend fun getService(argument: GetServicePlainArgs): GetServiceResult

Gets the status of service. Azure REST API version: 2023-04-15. Other available API versions: 2023-09-15, 2023-09-15-preview.

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

Gets the SQL container under an existing Azure Cosmos DB database account. Azure REST API version: 2023-04-15. Other available API versions: 2019-08-01, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview.

suspend fun getSqlResourceSqlContainer(argument: suspend GetSqlResourceSqlContainerPlainArgsBuilder.() -> Unit): GetSqlResourceSqlContainerResult
suspend fun getSqlResourceSqlContainer(accountName: String, containerName: String, databaseName: String, resourceGroupName: String): GetSqlResourceSqlContainerResult
Link copied to clipboard
suspend fun getSqlResourceSqlDatabase(argument: GetSqlResourceSqlDatabasePlainArgs): GetSqlResourceSqlDatabaseResult

Gets the SQL database under an existing Azure Cosmos DB database account with the provided name. Azure REST API version: 2023-04-15. Other available API versions: 2019-08-01, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview.

suspend fun getSqlResourceSqlDatabase(argument: suspend GetSqlResourceSqlDatabasePlainArgsBuilder.() -> Unit): GetSqlResourceSqlDatabaseResult
suspend fun getSqlResourceSqlDatabase(accountName: String, databaseName: String, resourceGroupName: String): GetSqlResourceSqlDatabaseResult
Link copied to clipboard
suspend fun getSqlResourceSqlRoleAssignment(argument: GetSqlResourceSqlRoleAssignmentPlainArgs): GetSqlResourceSqlRoleAssignmentResult

Retrieves the properties of an existing Azure Cosmos DB SQL Role Assignment with the given Id. Azure REST API version: 2023-04-15. Other available API versions: 2023-09-15, 2023-09-15-preview.

suspend fun getSqlResourceSqlRoleAssignment(argument: suspend GetSqlResourceSqlRoleAssignmentPlainArgsBuilder.() -> Unit): GetSqlResourceSqlRoleAssignmentResult
suspend fun getSqlResourceSqlRoleAssignment(accountName: String, resourceGroupName: String, roleAssignmentId: String): GetSqlResourceSqlRoleAssignmentResult
Link copied to clipboard
suspend fun getSqlResourceSqlRoleDefinition(argument: GetSqlResourceSqlRoleDefinitionPlainArgs): GetSqlResourceSqlRoleDefinitionResult

Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id. Azure REST API version: 2023-04-15. Other available API versions: 2023-09-15, 2023-09-15-preview.

suspend fun getSqlResourceSqlRoleDefinition(argument: suspend GetSqlResourceSqlRoleDefinitionPlainArgsBuilder.() -> Unit): GetSqlResourceSqlRoleDefinitionResult
suspend fun getSqlResourceSqlRoleDefinition(accountName: String, resourceGroupName: String, roleDefinitionId: String): GetSqlResourceSqlRoleDefinitionResult
Link copied to clipboard
suspend fun getSqlResourceSqlStoredProcedure(argument: GetSqlResourceSqlStoredProcedurePlainArgs): GetSqlResourceSqlStoredProcedureResult

Gets the SQL storedProcedure under an existing Azure Cosmos DB database account. Azure REST API version: 2023-04-15. Other available API versions: 2019-08-01, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview.

suspend fun getSqlResourceSqlStoredProcedure(argument: suspend GetSqlResourceSqlStoredProcedurePlainArgsBuilder.() -> Unit): GetSqlResourceSqlStoredProcedureResult
suspend fun getSqlResourceSqlStoredProcedure(accountName: String, containerName: String, databaseName: String, resourceGroupName: String, storedProcedureName: String): GetSqlResourceSqlStoredProcedureResult
Link copied to clipboard
suspend fun getSqlResourceSqlTrigger(argument: GetSqlResourceSqlTriggerPlainArgs): GetSqlResourceSqlTriggerResult

Gets the SQL trigger under an existing Azure Cosmos DB database account. Azure REST API version: 2023-04-15. Other available API versions: 2019-08-01, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview.

suspend fun getSqlResourceSqlTrigger(argument: suspend GetSqlResourceSqlTriggerPlainArgsBuilder.() -> Unit): GetSqlResourceSqlTriggerResult
suspend fun getSqlResourceSqlTrigger(accountName: String, containerName: String, databaseName: String, resourceGroupName: String, triggerName: String): GetSqlResourceSqlTriggerResult
Link copied to clipboard
suspend fun getSqlResourceSqlUserDefinedFunction(argument: GetSqlResourceSqlUserDefinedFunctionPlainArgs): GetSqlResourceSqlUserDefinedFunctionResult

Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account. Azure REST API version: 2023-04-15. Other available API versions: 2019-08-01, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview.

suspend fun getSqlResourceSqlUserDefinedFunction(argument: suspend GetSqlResourceSqlUserDefinedFunctionPlainArgsBuilder.() -> Unit): GetSqlResourceSqlUserDefinedFunctionResult
suspend fun getSqlResourceSqlUserDefinedFunction(accountName: String, containerName: String, databaseName: String, resourceGroupName: String, userDefinedFunctionName: String): GetSqlResourceSqlUserDefinedFunctionResult
Link copied to clipboard
suspend fun getTableResourceTable(argument: GetTableResourceTablePlainArgs): GetTableResourceTableResult

Gets the Tables under an existing Azure Cosmos DB database account with the provided name. Azure REST API version: 2023-04-15. Other available API versions: 2019-08-01, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview.

suspend fun getTableResourceTable(argument: suspend GetTableResourceTablePlainArgsBuilder.() -> Unit): GetTableResourceTableResult
suspend fun getTableResourceTable(accountName: String, resourceGroupName: String, tableName: String): GetTableResourceTableResult
Link copied to clipboard
suspend fun listDatabaseAccountConnectionStrings(argument: ListDatabaseAccountConnectionStringsPlainArgs): ListDatabaseAccountConnectionStringsResult

Lists the connection strings for the specified Azure Cosmos DB database account. Azure REST API version: 2023-04-15. Other available API versions: 2020-03-01, 2020-06-01-preview, 2020-09-01, 2021-04-01-preview, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview.

suspend fun listDatabaseAccountConnectionStrings(argument: suspend ListDatabaseAccountConnectionStringsPlainArgsBuilder.() -> Unit): ListDatabaseAccountConnectionStringsResult
suspend fun listDatabaseAccountConnectionStrings(accountName: String, resourceGroupName: String): ListDatabaseAccountConnectionStringsResult
Link copied to clipboard
suspend fun listDatabaseAccountKeys(argument: ListDatabaseAccountKeysPlainArgs): ListDatabaseAccountKeysResult

Lists the access keys for the specified Azure Cosmos DB database account. Azure REST API version: 2023-04-15. Other available API versions: 2020-03-01, 2020-06-01-preview, 2020-09-01, 2021-04-01-preview, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview.

suspend fun listDatabaseAccountKeys(argument: suspend ListDatabaseAccountKeysPlainArgsBuilder.() -> Unit): ListDatabaseAccountKeysResult
suspend fun listDatabaseAccountKeys(accountName: String, resourceGroupName: String): ListDatabaseAccountKeysResult
Link copied to clipboard
suspend fun listMongoClusterConnectionStrings(argument: ListMongoClusterConnectionStringsPlainArgs): ListMongoClusterConnectionStringsResult

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. Azure REST API version: 2023-03-15-preview. Other available API versions: 2023-09-15-preview.

suspend fun listMongoClusterConnectionStrings(argument: suspend ListMongoClusterConnectionStringsPlainArgsBuilder.() -> Unit): ListMongoClusterConnectionStringsResult
suspend fun listMongoClusterConnectionStrings(mongoClusterName: String, resourceGroupName: String): ListMongoClusterConnectionStringsResult
Link copied to clipboard
suspend fun listNotebookWorkspaceConnectionInfo(argument: ListNotebookWorkspaceConnectionInfoPlainArgs): ListNotebookWorkspaceConnectionInfoResult

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.

suspend fun listNotebookWorkspaceConnectionInfo(argument: suspend ListNotebookWorkspaceConnectionInfoPlainArgsBuilder.() -> Unit): ListNotebookWorkspaceConnectionInfoResult
suspend fun listNotebookWorkspaceConnectionInfo(accountName: String, notebookWorkspaceName: String, resourceGroupName: String): ListNotebookWorkspaceConnectionInfoResult