Dela via

Restorable Sql Databases - List

Tjänst:
Cosmos DB Resource Provider
API-version:
2025-04-15

Visa händelseflödet för alla mutationer som görs på alla Azure Cosmos DB SQL-databaser under det återställningsbara kontot. Detta hjälper till i scenariot där databasen togs bort av misstag för att få borttagningstiden. Det här API:et kräver behörigheten Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read

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

URI-parametrar

Name I Obligatorisk Typ Description
instanceId
 path True

string

InstanceId-GUID för ett återställningsbart databaskonto.
location
 path True

string

Cosmos DB-region med blanksteg mellan ord och varje ord med versaler.
subscriptionId
 path True

string

minLength: 1

ID för målprenumerationen.
api-version
 query True

string

minLength: 1

Den API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

RestorableSqlDatabasesListResult

Åtgärden har slutförts.
Other Status Codes

CloudError

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation Personifiera ditt användarkonto

Exempel

CosmosDBRestorableSqlDatabaseList

Exempelbegäran

GET https://management.azure.com/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases?api-version=2025-04-15

Exempelsvar

Statuskod:
200 
{
  "value": [
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/36f09704-6be3-4f33-aa05-17b73e504c75/restorableSqlDatabases/59c21367-b98b-4a8e-abb7-b6f46600decc",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases",
      "name": "59c21367-b98b-4a8e-abb7-b6f46600decc",
      "properties": {
        "resource": {
          "_rid": "DLB14gAAAA==",
          "eventTimestamp": "2020-09-02T19:45:03Z",
          "ownerId": "Database1",
          "ownerResourceId": "3fu-hg==",
          "operationType": "Create",
          "canUndelete": "invalid",
          "database": {
            "id": "Database1",
            "_rid": "3fu-hg==",
            "_self": "dbs/3fu-hg==/",
            "_etag": "\"0000c20a-0000-0700-0000-5f4ff63f0000\"",
            "_colls": "colls/",
            "_users": "users/"
          }
        }
      }
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases/8456cb17-cdb0-4c6a-8db8-d0ff3f886257",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases",
      "name": "8456cb17-cdb0-4c6a-8db8-d0ff3f886257",
      "properties": {
        "resource": {
          "_rid": "ESXNLAAAAA==",
          "eventTimestamp": "2020-09-02T19:53:42Z",
          "ownerId": "Database1",
          "ownerResourceId": "3fu-hg==",
          "database": {
            "id": "Database1",
            "_rid": "3fu-hg==",
            "_self": "dbs/3fu-hg==/",
            "_etag": "\"0000c20a-0000-0700-0000-5f4ff63f0000\"",
            "_colls": "colls/",
            "_users": "users/",
            "_ts": 1599075903
          },
          "operationType": "Delete",
          "canUndelete": "notRestorable",
          "canUndeleteReason": "Database already exists. Only deleted resources can be restored within same account."
        }
      }
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases/2c07991b-9c7c-4e85-be68-b18c1f2ff326",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases",
      "name": "2c07991b-9c7c-4e85-be68-b18c1f2ff326",
      "properties": {
        "resource": {
          "_rid": "aXFqUQAAAA==",
          "eventTimestamp": "2020-09-02T19:53:15Z",
          "ownerId": "Database2",
          "ownerResourceId": "0SziSg==",
          "database": {
            "id": "Database2",
            "_rid": "0SziSg==",
            "_self": "dbs/0SziSg==/",
            "_etag": "\"0000ca0a-0000-0700-0000-5f4ff82b0000\"",
            "_colls": "colls/",
            "_users": "users/"
          },
          "operationType": "Create",
          "canUndelete": "invalid"
        }
      }
    }
  ]
}

Definitioner

Name Description
CloudError

Ett felsvar från tjänsten.
CreateMode

Uppräkning för att ange läget för kontoskapande.
Database

Cosmos DB SQL-databasresursobjekt
ErrorResponse

Felsvar.
OperationType

Räkna upp för att ange händelsens åtgärdstyp.
Resource

Resursen för en Azure Cosmos DB SQL-databashändelse
ResourceRestoreParameters

Parametrar som anger information om återställningen.
RestorableSqlDatabaseGetResult

En Azure Cosmos DB SQL-databashändelse
RestorableSqlDatabasesListResult

Svar på liståtgärd som innehåller SQL-databashändelserna och deras egenskaper.

CloudError

Objekt

Ett felsvar från tjänsten.

Name Typ Description
error

ErrorResponse

Felsvar.

CreateMode

Uppräkning

Uppräkning för att ange läget för kontoskapande.

Värde Description
Default
Restore

Database

Objekt

Cosmos DB SQL-databasresursobjekt

Name Typ Standardvärde Description
_colls

string

En systemgenererad egenskap som angav den adresserbara sökvägen för samlingsresursen.
_etag

string

En systemgenererad egenskap som representerar resursetaggen som krävs för optimistisk samtidighetskontroll.
_rid

string

En systemgenererad egenskap. En unik identifierare.
_self

string

En systemgenererad egenskap som anger databasresursens adresserbara sökväg.
_ts

number

En systemgenererad egenskap som anger resursens senast uppdaterade tidsstämpel.
_users

string

En systemgenererad egenskap som anger den adresserbara sökvägen för användarresursen.
createMode

CreateMode

Default

Uppräkning för att ange läget för att skapa resurser.
id

string

Namn på Cosmos DB SQL-databasen
restoreParameters

ResourceRestoreParameters

Parametrar som anger information om återställningen

ErrorResponse

Objekt

Felsvar.

Name Typ Description
code

string

Felkod.
message

string

Felmeddelande som anger varför åtgärden misslyckades.

OperationType

Uppräkning

Räkna upp för att ange händelsens åtgärdstyp.

Värde Description
Create
Replace
Delete
Recreate
SystemOperation

Resource

Objekt

Resursen för en Azure Cosmos DB SQL-databashändelse

Name Typ Description
_rid

string

En systemgenererad egenskap. En unik identifierare.
canUndelete

string

Ett tillstånd för den här databasen för att identifiera om den här databasen kan återställas i samma konto.
canUndeleteReason

string

Anledningen till att den här databasen inte kan återställas i samma konto.
database

Database

Cosmos DB SQL-databasresursobjekt
eventTimestamp

string

Tiden då den här databashändelsen inträffade.
operationType

OperationType

Åtgärdstypen för den här databashändelsen.
ownerId

string

Namnet på SQL-databasen.
ownerResourceId

string

Resurs-ID för SQL-databasen.

ResourceRestoreParameters

Objekt

Parametrar som anger information om återställningen.

Name Typ Description
restoreSource

string

ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Till exempel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc

string (date-time)

Tid då kontot måste återställas (ISO-8601-format).
restoreWithTtlDisabled

boolean

Anger om det återställda kontot kommer att ha time-To-Live inaktiverat vid lyckad återställning.

RestorableSqlDatabaseGetResult

Objekt

En Azure Cosmos DB SQL-databashändelse

Name Typ Description
id

string

Den unika resursidentifieraren för ARM-resursen.
name

string

Namnet på ARM-resursen.
properties.resource

Resource

Resursen för en Azure Cosmos DB SQL-databashändelse
type

string

Typen av Azure-resurs.

RestorableSqlDatabasesListResult

Objekt

Svar på liståtgärd som innehåller SQL-databashändelserna och deras egenskaper.

Name Typ Description
value

RestorableSqlDatabaseGetResult[]

Lista över SQL-databashändelser och deras egenskaper.