Mongo DB Resources - List Mongo DB Databases

Lista os bancos de dados do MongoDB em uma conta de banco de dados existente do Azure Cosmos DB.

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

Parâmetros de URI

Name In Required Type Description
accountName
path True
  • string

Nome da conta de banco de dados do Cosmos DB.

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

resourceGroupName
path True
  • string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

subscriptionId
path True
  • string

A ID da assinatura de destino.

api-version
query True
  • string

A versão da API a ser usada para esta operação.

Respostas

Name Type Description
200 OK

As propriedades do banco de dados MongoDB foram recuperadas com êxito.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name Description
user_impersonation Representar sua conta de usuário

Exemplos

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"
        }
      }
    }
  ]
}

Definições

AutoscaleSettings
MongoDBDatabaseGetResults

Lista de bancos de dados do MongoDB e suas propriedades.

MongoDBDatabaseListResult

A resposta da operação Lista, que contém os bancos de dados do MongoDB e suas propriedades.

Options
Resource

AutoscaleSettings

Name Type Description
maxThroughput
  • integer

Representa a taxa de transferência máxima, o recurso pode escalar verticalmente.

MongoDBDatabaseGetResults

Lista de bancos de dados do MongoDB e suas propriedades.

Name Type Description
id
  • string

O identificador de recurso exclusivo do recurso arm.

location
  • string

O local do grupo de recursos ao qual o recurso pertence.

name
  • string

O nome do recurso ARM.

properties.options
properties.resource
tags
  • object

As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB".

type
  • string

O tipo de recurso do Azure.

MongoDBDatabaseListResult

A resposta da operação Lista, que contém os bancos de dados do MongoDB e suas propriedades.

Name Type Description
value

Lista de bancos de dados do MongoDB e suas propriedades.

Options

Name Type Description
autoscaleSettings

Especifica as configurações de dimensionamento automático.

throughput
  • integer

Valor da taxa de transferência de recurso do Cosmos DB ou dimensionamento automático. Use o recurso ThroughputSetting ao recuperar detalhes da oferta.

Resource

Name Type Description
_etag
  • string

Uma propriedade gerada pelo sistema que representa a etag de recurso necessária para o controle de simultaneidade otimista.

_rid
  • string

Uma propriedade gerada pelo sistema. Um identificador exclusivo.

_ts
  • number

Uma propriedade gerada pelo sistema que indica o último carimbo de data/hora atualizado do recurso.

id
  • string

Nome do banco de dados MongoDB do Cosmos DB