Restorable Sql Resources - List

Referencia

Service:: Cosmos DB Resource Provider

API Version:: 2024-05-15

Devuelve una lista de las combinaciones de base de datos y contenedor que existen en la cuenta en la marca de tiempo y ubicación especificadas. Esto ayuda en escenarios para validar los recursos existentes en una marca de tiempo y ubicación determinadas. Esta API requiere el permiso "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read".

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlResources?api-version=2024-05-15

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlResources?api-version=2024-05-15&restoreLocation={restoreLocation}&restoreTimestampInUtc={restoreTimestampInUtc}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
instanceId	path	True	string	GUID instanceId de una cuenta de base de datos restaurable.
location	path	True	string	Región de Cosmos DB, con espacios entre palabras y cada palabra en mayúsculas.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.
restoreLocation	query		string	Ubicación donde se almacenan los recursos restaurables.
restoreTimestampInUtc	query		string	Marca de tiempo en la que existían los recursos restaurables.

Respuestas

Nombre	Tipo	Description
200 OK	RestorableSqlResourcesListResult	La operación se ha completado correctamente.
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	Suplantación de su cuenta de usuario

Ejemplos

CosmosDBRestorableSqlResourceList

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-05-15&restoreLocation=WestUS&restoreTimestampInUtc=06/01/2022 4:56

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-05-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

Sample Response

Status code:: 200

{
  "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": []
    }
  ]
}

Definiciones

Nombre	Description
CloudError	Respuesta de error del servicio.
ErrorResponse	Respuesta de error.
RestorableSqlResourcesGetResult	Bases de datos específicas para restaurar.
RestorableSqlResourcesListResult	Respuesta de la operación de lista, que contiene los recursos de SQL restaurables.

CloudError

Respuesta de error del servicio.

Nombre	Tipo	Description
error	ErrorResponse	Respuesta de error.

ErrorResponse

Respuesta de error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

RestorableSqlResourcesGetResult

Bases de datos específicas para restaurar.

Nombre	Tipo	Description
collectionNames	string[]	Los nombres de las colecciones disponibles para restaurar.
databaseName	string	Nombre de la base de datos disponible para restaurar.
id	string	Identificador de recurso único del recurso de ARM.
name	string	Nombre del recurso de ARM.
type	string	Tipo de recurso de Azure.