Retorna uma lista de combinação de banco de dados e contêiner que existem na conta no carimbo de data/hora e no local determinados. Isso ajuda em cenários para validar quais recursos existem em determinado carimbo de data/hora e local. Esta API requer a permissão 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read'.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlResources?api-version=2024-11-15
Com parâmetros opcionais:
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlResources?api-version=2024-11-15&restoreLocation={restoreLocation}&restoreTimestampInUtc={restoreTimestampInUtc}
Parâmetros do URI
Name |
Em |
Necessário |
Tipo |
Description |
instanceId
|
path |
True
|
string
|
O GUID instanceId de uma conta de banco de dados restaurável.
|
location
|
path |
True
|
string
|
Região do Cosmos DB, com espaços entre palavras e cada palavra em maiúsculas.
|
subscriptionId
|
path |
True
|
string
|
A ID da assinatura de destino.
|
api-version
|
query |
True
|
string
|
A versão da API a ser usada para esta operação.
|
restoreLocation
|
query |
|
string
|
O local onde os recursos restauráveis estão localizados.
|
restoreTimestampInUtc
|
query |
|
string
|
O carimbo de data/hora quando os recursos restauráveis existiram.
|
Respostas
Segurança
azure_auth
Azure Ative Directory OAuth2 Flow
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name |
Description |
user_impersonation
|
Personificar a sua conta de utilizador
|
Exemplos
CosmosDBRestorableSqlResourceList
Pedido de amostra
GET https://management.azure.com/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlResources?api-version=2024-11-15&restoreLocation=WestUS&restoreTimestampInUtc=06/01/2022 4:56
/**
* Samples for RestorableSqlResources List.
*/
public final class Main {
/*
* x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/
* CosmosDBRestorableSqlResourceList.json
*/
/**
* Sample code: CosmosDBRestorableSqlResourceList.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void cosmosDBRestorableSqlResourceList(com.azure.resourcemanager.AzureResourceManager azure) {
azure.cosmosDBAccounts().manager().serviceClient().getRestorableSqlResources().list("WestUS",
"d9b26648-2f53-4541-b3d8-3044f4f9810d", "WestUS", "06/01/2022 4:56", com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
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_restorable_sql_resource_list.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="2296c272-5d55-40d9-bc05-4d56dc2d7588",
)
response = client.restorable_sql_resources.list(
location="WestUS",
instance_id="d9b26648-2f53-4541-b3d8-3044f4f9810d",
)
for item in response:
print(item)
# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBRestorableSqlResourceList.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
package armcosmos_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v3"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ded6306d00ae294c24211e5069c1f56b15ba8ef5/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBRestorableSqlResourceList.json
func ExampleRestorableSQLResourcesClient_NewListPager() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewRestorableSQLResourcesClient().NewListPager("WestUS", "d9b26648-2f53-4541-b3d8-3044f4f9810d", &armcosmos.RestorableSQLResourcesClientListOptions{RestoreLocation: to.Ptr("WestUS"),
RestoreTimestampInUTC: to.Ptr("06/01/2022 4:56"),
})
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.RestorableSQLResourcesListResult = armcosmos.RestorableSQLResourcesListResult{
// Value: []*armcosmos.RestorableSQLResourcesGetResult{
// {
// Name: to.Ptr("Database1"),
// Type: to.Ptr("Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablesqlresources"),
// CollectionNames: []*string{
// to.Ptr("Container1")},
// DatabaseName: to.Ptr("Database1"),
// ID: to.Ptr("/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablesqlresources/Database1"),
// },
// {
// Name: to.Ptr("Database2"),
// Type: to.Ptr("Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablesqlresources"),
// CollectionNames: []*string{
// to.Ptr("Container1"),
// to.Ptr("Container2")},
// DatabaseName: to.Ptr("Database2"),
// ID: to.Ptr("/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablesqlresources/Database2"),
// },
// {
// Name: to.Ptr("Database3"),
// Type: to.Ptr("Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablesqlresources"),
// CollectionNames: []*string{
// },
// DatabaseName: to.Ptr("Database3"),
// ID: to.Ptr("/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablesqlresources/Database3"),
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Return a list of database and container combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
*
* @summary Return a list of database and container combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.
* x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBRestorableSqlResourceList.json
*/
async function cosmosDbRestorableSqlResourceList() {
const subscriptionId =
process.env["COSMOSDB_SUBSCRIPTION_ID"] || "2296c272-5d55-40d9-bc05-4d56dc2d7588";
const location = "WestUS";
const instanceId = "d9b26648-2f53-4541-b3d8-3044f4f9810d";
const restoreLocation = "WestUS";
const restoreTimestampInUtc = "06/01/2022 4:56";
const options = {
restoreLocation,
restoreTimestampInUtc,
};
const credential = new DefaultAzureCredential();
const client = new CosmosDBManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.restorableSqlResources.list(location, instanceId, options)) {
resArray.push(item);
}
console.log(resArray);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Resposta da amostra
{
"value": [
{
"id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablesqlresources/Database1",
"type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablesqlresources",
"name": "Database1",
"databaseName": "Database1",
"collectionNames": [
"Container1"
]
},
{
"id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablesqlresources/Database2",
"type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablesqlresources",
"name": "Database2",
"databaseName": "Database2",
"collectionNames": [
"Container1",
"Container2"
]
},
{
"id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablesqlresources/Database3",
"type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablesqlresources",
"name": "Database3",
"databaseName": "Database3",
"collectionNames": []
}
]
}
Definições
CloudError
Uma resposta de erro do serviço.
ErrorResponse
Resposta de erro.
Name |
Tipo |
Description |
code
|
string
|
Código de erro.
|
message
|
string
|
Mensagem de erro indicando por que a operação falhou.
|
RestorableSqlResourcesGetResult
Bases de Dados específicas para restaurar.
Name |
Tipo |
Description |
collectionNames
|
string[]
|
Os nomes das coleções disponíveis para restauração.
|
databaseName
|
string
|
O nome do banco de dados disponível para restauração.
|
id
|
string
|
O identificador de recurso exclusivo do recurso ARM.
|
name
|
string
|
O nome do recurso ARM.
|
type
|
string
|
O tipo de recurso do Azure.
|
RestorableSqlResourcesListResult
A resposta da operação List, que contém os recursos SQL restauráveis.