Возвращает список списков базы данных gremlin и графов, которые существуют в учетной записи в заданной метке времени и расположении. Это помогает в сценариях проверить, какие ресурсы существуют в заданной метке времени и расположении. Для этого API требуется разрешение "Microsoft.DocumentDB/location/restorableDatabaseAccounts/.../read".
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGremlinResources?api-version=2024-11-15
С использованием необязательных параметров:
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGremlinResources?api-version=2024-11-15&restoreLocation={restoreLocation}&restoreTimestampInUtc={restoreTimestampInUtc}
Параметры URI
| Имя |
В |
Обязательно |
Тип |
Описание |
|
instanceId
|
path |
True
|
string
|
ИДЕНТИФИКАТОР GUID экземпляра учетной записи базы данных, допускающего восстановление.
|
|
location
|
path |
True
|
string
|
Регион Cosmos DB с пробелами между словами и каждой прописной буквой слова.
|
|
subscriptionId
|
path |
True
|
string
|
Идентификатор целевой подписки.
|
|
api-version
|
query |
True
|
string
|
Версия API, используемая для этой операции.
|
|
restoreLocation
|
query |
|
string
|
Расположение, в котором находятся восстанавливаемые ресурсы.
|
|
restoreTimestampInUtc
|
query |
|
string
|
Метка времени при наличии восстанавливаемых ресурсов.
|
Ответы
Безопасность
azure_auth
Поток OAuth2 Azure Active Directory
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя |
Описание |
|
user_impersonation
|
Олицетворения учетной записи пользователя
|
Примеры
CosmosDBRestorableGremlinResourceList
Образец запроса
GET https://management.azure.com/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources?api-version=2024-11-15&restoreLocation=WestUS&restoreTimestampInUtc=06/01/2022 4:56
/**
* Samples for RestorableGremlinResources List.
*/
public final class Main {
/*
* x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/
* CosmosDBRestorableGremlinResourceList.json
*/
/**
* Sample code: CosmosDBRestorableGremlinResourceList.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void cosmosDBRestorableGremlinResourceList(com.azure.resourcemanager.AzureResourceManager azure) {
azure.cosmosDBAccounts().manager().serviceClient().getRestorableGremlinResources().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_gremlin_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_gremlin_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/CosmosDBRestorableGremlinResourceList.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/CosmosDBRestorableGremlinResourceList.json
func ExampleRestorableGremlinResourcesClient_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.NewRestorableGremlinResourcesClient().NewListPager("WestUS", "d9b26648-2f53-4541-b3d8-3044f4f9810d", &armcosmos.RestorableGremlinResourcesClientListOptions{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.RestorableGremlinResourcesListResult = armcosmos.RestorableGremlinResourcesListResult{
// Value: []*armcosmos.RestorableGremlinResourcesGetResult{
// {
// Name: to.Ptr("Database1"),
// Type: to.Ptr("Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinResources"),
// DatabaseName: to.Ptr("Database1"),
// GraphNames: []*string{
// to.Ptr("Graph1")},
// ID: to.Ptr("/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources/Database1"),
// },
// {
// Name: to.Ptr("Database2"),
// Type: to.Ptr("Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinResources"),
// DatabaseName: to.Ptr("Database2"),
// GraphNames: []*string{
// to.Ptr("Graph1"),
// to.Ptr("Graph2")},
// ID: to.Ptr("/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources/Database2"),
// },
// {
// Name: to.Ptr("Database3"),
// Type: to.Ptr("Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinResources"),
// DatabaseName: to.Ptr("Database3"),
// GraphNames: []*string{
// },
// ID: to.Ptr("/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources/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 gremlin database and graphs 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 gremlin database and graphs 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/CosmosDBRestorableGremlinResourceList.json
*/
async function cosmosDbRestorableGremlinResourceList() {
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.restorableGremlinResources.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
Пример ответа
{
"value": [
{
"id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources/Database1",
"type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinResources",
"name": "Database1",
"databaseName": "Database1",
"graphNames": [
"Graph1"
]
},
{
"id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources/Database2",
"type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinResources",
"name": "Database2",
"databaseName": "Database2",
"graphNames": [
"Graph1",
"Graph2"
]
},
{
"id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources/Database3",
"type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinResources",
"name": "Database3",
"databaseName": "Database3",
"graphNames": []
}
]
}
Определения
CloudError
Ответ на ошибку службы.
ErrorResponse
Ответ на ошибку.
| Имя |
Тип |
Описание |
|
code
|
string
|
Код ошибки.
|
|
message
|
string
|
Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.
|
RestorableGremlinResourcesGetResult
Определенные базы данных для восстановления.
| Имя |
Тип |
Описание |
|
databaseName
|
string
|
Имя базы данных gremlin, доступной для восстановления.
|
|
graphNames
|
string[]
|
Имена графов, доступных для восстановления.
|
|
id
|
string
|
Уникальный идентификатор ресурса ARM.
|
|
name
|
string
|
Имя ресурса ARM.
|
|
type
|
string
|
Тип ресурса Azure.
|
RestorableGremlinResourcesListResult
Ответ операции list, содержащий восстанавливаемые ресурсы Gremlin.