Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. cosmosdb
  5. getRestorableDatabaseAccounts

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.cosmosdb.getRestorableDatabaseAccounts

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Use this data source to access information about Cosmos DB Restorable Database Accounts.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.cosmosdb.getRestorableDatabaseAccounts({
    name: "example-ca",
    location: "West Europe",
});
export const id = example.then(example => example.id);
Copy
import pulumi
import pulumi_azure as azure

example = azure.cosmosdb.get_restorable_database_accounts(name="example-ca",
    location="West Europe")
pulumi.export("id", example.id)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/cosmosdb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := cosmosdb.GetRestorableDatabaseAccounts(ctx, &cosmosdb.GetRestorableDatabaseAccountsArgs{
			Name:     "example-ca",
			Location: "West Europe",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", example.Id)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.CosmosDB.GetRestorableDatabaseAccounts.Invoke(new()
    {
        Name = "example-ca",
        Location = "West Europe",
    });

    return new Dictionary<string, object?>
    {
        ["id"] = example.Apply(getRestorableDatabaseAccountsResult => getRestorableDatabaseAccountsResult.Id),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.cosmosdb.CosmosdbFunctions;
import com.pulumi.azure.cosmosdb.inputs.GetRestorableDatabaseAccountsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = CosmosdbFunctions.getRestorableDatabaseAccounts(GetRestorableDatabaseAccountsArgs.builder()
            .name("example-ca")
            .location("West Europe")
            .build());

        ctx.export("id", example.applyValue(getRestorableDatabaseAccountsResult -> getRestorableDatabaseAccountsResult.id()));
    }
}
Copy
variables:
  example:
    fn::invoke:
      function: azure:cosmosdb:getRestorableDatabaseAccounts
      arguments:
        name: example-ca
        location: West Europe
outputs:
  id: ${example.id}
Copy

Using getRestorableDatabaseAccounts

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 getRestorableDatabaseAccounts(args: GetRestorableDatabaseAccountsArgs, opts?: InvokeOptions): Promise<GetRestorableDatabaseAccountsResult>
function getRestorableDatabaseAccountsOutput(args: GetRestorableDatabaseAccountsOutputArgs, opts?: InvokeOptions): Output<GetRestorableDatabaseAccountsResult>
Copy
def get_restorable_database_accounts(location: Optional[str] = None,
                                     name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetRestorableDatabaseAccountsResult
def get_restorable_database_accounts_output(location: Optional[pulumi.Input[str]] = None,
                                     name: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetRestorableDatabaseAccountsResult]
Copy
func GetRestorableDatabaseAccounts(ctx *Context, args *GetRestorableDatabaseAccountsArgs, opts ...InvokeOption) (*GetRestorableDatabaseAccountsResult, error)
func GetRestorableDatabaseAccountsOutput(ctx *Context, args *GetRestorableDatabaseAccountsOutputArgs, opts ...InvokeOption) GetRestorableDatabaseAccountsResultOutput
Copy

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

public static class GetRestorableDatabaseAccounts 
{
    public static Task<GetRestorableDatabaseAccountsResult> InvokeAsync(GetRestorableDatabaseAccountsArgs args, InvokeOptions? opts = null)
    public static Output<GetRestorableDatabaseAccountsResult> Invoke(GetRestorableDatabaseAccountsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRestorableDatabaseAccountsResult> getRestorableDatabaseAccounts(GetRestorableDatabaseAccountsArgs args, InvokeOptions options)
public static Output<GetRestorableDatabaseAccountsResult> getRestorableDatabaseAccounts(GetRestorableDatabaseAccountsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure:cosmosdb/getRestorableDatabaseAccounts:getRestorableDatabaseAccounts
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Location This property is required. string
The location where the Cosmos DB Database Account.
Name This property is required. string
The name of this Cosmos DB Database Account.
Location This property is required. string
The location where the Cosmos DB Database Account.
Name This property is required. string
The name of this Cosmos DB Database Account.
location This property is required. String
The location where the Cosmos DB Database Account.
name This property is required. String
The name of this Cosmos DB Database Account.
location This property is required. string
The location where the Cosmos DB Database Account.
name This property is required. string
The name of this Cosmos DB Database Account.
location This property is required. str
The location where the Cosmos DB Database Account.
name This property is required. str
The name of this Cosmos DB Database Account.
location This property is required. String
The location where the Cosmos DB Database Account.
name This property is required. String
The name of this Cosmos DB Database Account.

getRestorableDatabaseAccounts Result

The following output properties are available:

Accounts List<GetRestorableDatabaseAccountsAccount>
One or more accounts blocks as defined below.
Id string
The provider-assigned unique ID for this managed resource.
Location string
The location of the regional Cosmos DB Restorable Database Account.
Name string
Accounts []GetRestorableDatabaseAccountsAccount
One or more accounts blocks as defined below.
Id string
The provider-assigned unique ID for this managed resource.
Location string
The location of the regional Cosmos DB Restorable Database Account.
Name string
accounts List<GetRestorableDatabaseAccountsAccount>
One or more accounts blocks as defined below.
id String
The provider-assigned unique ID for this managed resource.
location String
The location of the regional Cosmos DB Restorable Database Account.
name String
accounts GetRestorableDatabaseAccountsAccount[]
One or more accounts blocks as defined below.
id string
The provider-assigned unique ID for this managed resource.
location string
The location of the regional Cosmos DB Restorable Database Account.
name string
accounts Sequence[GetRestorableDatabaseAccountsAccount]
One or more accounts blocks as defined below.
id str
The provider-assigned unique ID for this managed resource.
location str
The location of the regional Cosmos DB Restorable Database Account.
name str
accounts List<Property Map>
One or more accounts blocks as defined below.
id String
The provider-assigned unique ID for this managed resource.
location String
The location of the regional Cosmos DB Restorable Database Account.
name String

Supporting Types

GetRestorableDatabaseAccountsAccount

ApiType This property is required. string
The API type of the Cosmos DB Restorable Database Account.
CreationTime This property is required. string
The creation time of the regional Cosmos DB Restorable Database Account.
DeletionTime This property is required. string
The deletion time of the regional Cosmos DB Restorable Database Account.
Id This property is required. string
The ID of the Cosmos DB Restorable Database Account.
RestorableLocations This property is required. List<GetRestorableDatabaseAccountsAccountRestorableLocation>
One or more restorable_locations blocks as defined below.
ApiType This property is required. string
The API type of the Cosmos DB Restorable Database Account.
CreationTime This property is required. string
The creation time of the regional Cosmos DB Restorable Database Account.
DeletionTime This property is required. string
The deletion time of the regional Cosmos DB Restorable Database Account.
Id This property is required. string
The ID of the Cosmos DB Restorable Database Account.
RestorableLocations This property is required. []GetRestorableDatabaseAccountsAccountRestorableLocation
One or more restorable_locations blocks as defined below.
apiType This property is required. String
The API type of the Cosmos DB Restorable Database Account.
creationTime This property is required. String
The creation time of the regional Cosmos DB Restorable Database Account.
deletionTime This property is required. String
The deletion time of the regional Cosmos DB Restorable Database Account.
id This property is required. String
The ID of the Cosmos DB Restorable Database Account.
restorableLocations This property is required. List<GetRestorableDatabaseAccountsAccountRestorableLocation>
One or more restorable_locations blocks as defined below.
apiType This property is required. string
The API type of the Cosmos DB Restorable Database Account.
creationTime This property is required. string
The creation time of the regional Cosmos DB Restorable Database Account.
deletionTime This property is required. string
The deletion time of the regional Cosmos DB Restorable Database Account.
id This property is required. string
The ID of the Cosmos DB Restorable Database Account.
restorableLocations This property is required. GetRestorableDatabaseAccountsAccountRestorableLocation[]
One or more restorable_locations blocks as defined below.
api_type This property is required. str
The API type of the Cosmos DB Restorable Database Account.
creation_time This property is required. str
The creation time of the regional Cosmos DB Restorable Database Account.
deletion_time This property is required. str
The deletion time of the regional Cosmos DB Restorable Database Account.
id This property is required. str
The ID of the Cosmos DB Restorable Database Account.
restorable_locations This property is required. Sequence[GetRestorableDatabaseAccountsAccountRestorableLocation]
One or more restorable_locations blocks as defined below.
apiType This property is required. String
The API type of the Cosmos DB Restorable Database Account.
creationTime This property is required. String
The creation time of the regional Cosmos DB Restorable Database Account.
deletionTime This property is required. String
The deletion time of the regional Cosmos DB Restorable Database Account.
id This property is required. String
The ID of the Cosmos DB Restorable Database Account.
restorableLocations This property is required. List<Property Map>
One or more restorable_locations blocks as defined below.

GetRestorableDatabaseAccountsAccountRestorableLocation

CreationTime This property is required. string
The creation time of the regional Cosmos DB Restorable Database Account.
DeletionTime This property is required. string
The deletion time of the regional Cosmos DB Restorable Database Account.
Location This property is required. string
The location where the Cosmos DB Database Account.
RegionalDatabaseAccountInstanceId This property is required. string
The instance ID of the regional Cosmos DB Restorable Database Account.
CreationTime This property is required. string
The creation time of the regional Cosmos DB Restorable Database Account.
DeletionTime This property is required. string
The deletion time of the regional Cosmos DB Restorable Database Account.
Location This property is required. string
The location where the Cosmos DB Database Account.
RegionalDatabaseAccountInstanceId This property is required. string
The instance ID of the regional Cosmos DB Restorable Database Account.
creationTime This property is required. String
The creation time of the regional Cosmos DB Restorable Database Account.
deletionTime This property is required. String
The deletion time of the regional Cosmos DB Restorable Database Account.
location This property is required. String
The location where the Cosmos DB Database Account.
regionalDatabaseAccountInstanceId This property is required. String
The instance ID of the regional Cosmos DB Restorable Database Account.
creationTime This property is required. string
The creation time of the regional Cosmos DB Restorable Database Account.
deletionTime This property is required. string
The deletion time of the regional Cosmos DB Restorable Database Account.
location This property is required. string
The location where the Cosmos DB Database Account.
regionalDatabaseAccountInstanceId This property is required. string
The instance ID of the regional Cosmos DB Restorable Database Account.
creation_time This property is required. str
The creation time of the regional Cosmos DB Restorable Database Account.
deletion_time This property is required. str
The deletion time of the regional Cosmos DB Restorable Database Account.
location This property is required. str
The location where the Cosmos DB Database Account.
regional_database_account_instance_id This property is required. str
The instance ID of the regional Cosmos DB Restorable Database Account.
creationTime This property is required. String
The creation time of the regional Cosmos DB Restorable Database Account.
deletionTime This property is required. String
The deletion time of the regional Cosmos DB Restorable Database Account.
location This property is required. String
The location where the Cosmos DB Database Account.
regionalDatabaseAccountInstanceId This property is required. String
The instance ID of the regional Cosmos DB Restorable Database Account.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure