Restorable Database Accounts - List By Location

Referencia

Service:: Cosmos DB Resource Provider

API Version:: 2024-05-15

Enumera todas las cuentas de base de datos de Azure Cosmos DB restaurables disponibles en la suscripción y en una región. Esta llamada requiere el permiso "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read".

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
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.

Respuestas

Nombre	Tipo	Description
200 OK	RestorableDatabaseAccountsListResult	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

CosmosDBRestorableDatabaseAccountList

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts?api-version=2024-05-15

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_database_account_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="subid",
    )

    response = client.restorable_database_accounts.list_by_location(
        location="West US",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/examples/CosmosDBRestorableDatabaseAccountList.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/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d",
      "name": "d9b26648-2f53-4541-b3d8-3044f4f9810d",
      "location": "West US",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts",
      "properties": {
        "accountName": "ddb1",
        "creationTime": "2020-04-11T21:56:15Z",
        "deletionTime": "2021-03-12T22:05:09Z",
        "oldestRestorableTime": "2021-03-12T22:05:09Z",
        "apiType": "Sql",
        "restorableLocations": [
          {
            "locationName": "South Central US",
            "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5",
            "creationTime": "2020-10-30T21:13:10Z",
            "deletionTime": "2020-10-30T21:13:35Z"
          },
          {
            "locationName": "West US",
            "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c",
            "creationTime": "2020-10-30T21:13:10Z"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/4f9e6ace-ac7a-446c-98bc-194c502a06b4",
      "name": "4f9e6ace-ac7a-446c-98bc-194c502a06b4",
      "location": "West US",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts",
      "properties": {
        "accountName": "ddb2",
        "creationTime": "2020-05-01T08:05:18Z",
        "oldestRestorableTime": "2020-05-01T08:05:18Z",
        "apiType": "Sql",
        "restorableLocations": [
          {
            "locationName": "South Central US",
            "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5",
            "creationTime": "2020-10-30T21:13:10Z",
            "deletionTime": "2020-10-30T21:13:35Z"
          },
          {
            "locationName": "West US",
            "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c",
            "creationTime": "2020-10-30T21:13:10Z"
          }
        ]
      }
    }
  ]
}

Definiciones

Nombre	Description
ApiType	Enumeración para indicar el tipo de API de la cuenta de base de datos restaurable.
CloudError	Respuesta de error del servicio.
ErrorResponse	Respuesta de error.
RestorableDatabaseAccountGetResult	Una cuenta de base de datos restaurable de Azure Cosmos DB.
RestorableDatabaseAccountsListResult	Respuesta de la operación de enumeración, que contiene las cuentas de base de datos restaurables y sus propiedades.
RestorableLocationResource	Propiedades de la cuenta de restauración regional.

ApiType

Enumeración para indicar el tipo de API de la cuenta de base de datos restaurable.

Nombre	Tipo	Description
Cassandra	string
Gremlin	string
GremlinV2	string
MongoDB	string
Sql	string
Table	string

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.

RestorableDatabaseAccountGetResult

Una cuenta de base de datos restaurable de Azure Cosmos DB.

Nombre	Tipo	Description
id	string	Identificador de recurso único del recurso de ARM.
location	string	Ubicación del grupo de recursos al que pertenece el recurso.
name	string	Nombre del recurso de ARM.
properties.accountName	string	Nombre de la cuenta de base de datos global.
properties.apiType	ApiType	Tipo de API de la cuenta de base de datos restaurable.
properties.creationTime	string	Hora de creación de la cuenta de base de datos restaurable (formato ISO-8601).
properties.deletionTime	string	La hora a la que se eliminó la cuenta de base de datos restaurable (formato ISO-8601).
properties.oldestRestorableTime	string	La hora menos reciente en la que se puede restaurar la cuenta de base de datos a (formato ISO-8601).
properties.restorableLocations	RestorableLocationResource[]	Lista de regiones desde donde se puede restaurar la cuenta de base de datos.
type	string	Tipo de recurso de Azure.

RestorableDatabaseAccountsListResult

Respuesta de la operación de enumeración, que contiene las cuentas de base de datos restaurables y sus propiedades.

Nombre	Tipo	Description
value	RestorableDatabaseAccountGetResult[]	Lista de cuentas de base de datos restaurables y sus propiedades.

RestorableLocationResource

Propiedades de la cuenta de restauración regional.

Nombre	Tipo	Description
creationTime	string	Hora de creación de la cuenta de base de datos restaurable regional (formato ISO-8601).
deletionTime	string	La hora a la que se eliminó la cuenta de base de datos restaurable regional (formato ISO-8601).
locationName	string	Ubicación de la cuenta de restauración regional.
regionalDatabaseAccountInstanceId	string	Identificador de instancia de la cuenta restaurable regional.

Compartir a través de