Mongo DB Resources - List Mongo DB Databases

Listet die MongoDB-Datenbanken unter einem vorhandenen Azure Cosmos DB-Datenbankkonto auf.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases?api-version=2022-05-15

URI-Parameter

Name In Required Type Description
accountName
path True
  • string

Name des Cosmos DB-Datenbankkontos.

Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*

resourceGroupName
path True
  • string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True
  • string

Hierbei handelt es sich um die ID des Zielabonnements.

api-version
query True
  • string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name Type Description
200 OK

Die MongoDB-Datenbankeigenschaften wurden erfolgreich abgerufen.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

Scopes

Name Description
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

CosmosDBMongoDBDatabaseList

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases?api-version=2022-05-15

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName",
      "name": "databaseName",
      "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases",
      "location": "West US",
      "tags": {},
      "properties": {
        "resource": {
          "id": "databaseName"
        }
      }
    }
  ]
}

Definitionen

AutoscaleSettings
MongoDBDatabaseGetResults

Liste der MongoDB-Datenbanken und deren Eigenschaften.

MongoDBDatabaseListResult

Die Antwort auf den Listenvorgang, die die MongoDB-Datenbanken und deren Eigenschaften enthält.

Options
Resource

AutoscaleSettings

Name Type Description
maxThroughput
  • integer

Stellt den maximalen Durchsatz dar, kann die Ressource bis zu skalieren.

MongoDBDatabaseGetResults

Liste der MongoDB-Datenbanken und deren Eigenschaften.

Name Type Description
id
  • string

Der eindeutige Ressourcenbezeichner der ARM-Ressource.

location
  • string

Der Speicherort der Ressourcengruppe, zu der die Ressource gehört.

name
  • string

Der Name der ARM-Ressource.

properties.options
properties.resource
tags
  • object

Tags sind eine Liste der Schlüsselwertpaare, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Maximal 15 Tags können für eine Ressource bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp wird beispielsweise mit "defaultExperience" festgelegt: "Cassandra". Aktuelle "defaultExperience"-Werte umfassen auch "Table", "Graph", "DocumentDB" und "MongoDB".

type
  • string

Der Typ der Azure-Ressource.

MongoDBDatabaseListResult

Die Antwort auf den Listenvorgang, die die MongoDB-Datenbanken und deren Eigenschaften enthält.

Name Type Description
value

Liste der MongoDB-Datenbanken und deren Eigenschaften.

Options

Name Type Description
autoscaleSettings

Gibt die Einstellungen für die Automatische Skalierung an.

throughput
  • integer

Wert des Cosmos DB-Ressourcendurchsatzs oder autoscaleSettings. Verwenden Sie die DurchsatzSetting-Ressource beim Abrufen von Angebotsdetails.

Resource

Name Type Description
_etag
  • string

Eine systemgenerierte Eigenschaft, die das Ressourcen-etag darstellt, das für das optimistische Übereinstimmungssteuerelement erforderlich ist.

_rid
  • string

Eine systemgenerierte Eigenschaft. Einen eindeutigen Bezeichner.

_ts
  • number

Eine systemgenerierte Eigenschaft, die den letzten aktualisierten Zeitstempel der Ressource angibt.

id
  • string

Name der Cosmos DB MongoDB-Datenbank