Gremlin Resources - Get Gremlin Database
Ottiene i database Gremlin con un account di database Azure Cosmos DB esistente con il nome specificato.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}?api-version=2024-05-15
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
account
|
path | True |
string |
Nome dell'account del database Cosmos DB. Criterio di espressione regolare: |
database
|
path | True |
string |
Nome del database Cosmos DB. |
resource
|
path | True |
string |
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole. |
subscription
|
path | True |
string |
ID della sottoscrizione di destinazione. |
api-version
|
query | True |
string |
Versione dell'API da usare per questa operazione. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
La proprietà del database Gremlin è stata recuperata correttamente. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
Nome | Descrizione |
---|---|
user_impersonation | Rappresentare l'account utente |
Esempio
CosmosDBGremlinDatabaseGet
Esempio di richiesta
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName?api-version=2024-05-15
Risposta di esempio
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName",
"name": "databaseName",
"type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases",
"location": "West US",
"tags": {},
"properties": {
"resource": {
"id": "databaseName",
"_rid": "CqNBAA==",
"_ts": 1449602962,
"_etag": "\"00000a00-0000-0000-0000-56672f920000\""
}
}
}
Definizioni
Nome | Descrizione |
---|---|
Autoscale |
|
Create |
Enumerazione per indicare la modalità di creazione dell'account. |
Gremlin |
Un database Gremlin di Azure Cosmos DB. |
Options | |
Resource | |
Resource |
Parametri per indicare le informazioni sul ripristino. |
AutoscaleSettings
Nome | Tipo | Descrizione |
---|---|---|
maxThroughput |
integer |
Rappresenta la velocità effettiva massima, la risorsa può aumentare le prestazioni. |
CreateMode
Enumerazione per indicare la modalità di creazione dell'account.
Nome | Tipo | Descrizione |
---|---|---|
Default |
string |
|
Restore |
string |
GremlinDatabaseGetResults
Un database Gremlin di Azure Cosmos DB.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
Identificatore univoco della risorsa arm. |
location |
string |
Posizione del gruppo di risorse a cui appartiene la risorsa. |
name |
string |
Nome della risorsa arm. |
properties.options | ||
properties.resource | ||
tags |
object |
I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB". |
type |
string |
Tipo di risorsa di Azure. |
Options
Nome | Tipo | Descrizione |
---|---|---|
autoscaleSettings |
Specifica le impostazioni di scalabilità automatica. |
|
throughput |
integer |
Valore della velocità effettiva della risorsa Cosmos DB o delle impostazioni di scalabilità automatica. Usare la risorsa ThroughputSetting durante il recupero dei dettagli dell'offerta. |
Resource
Nome | Tipo | Valore predefinito | Descrizione |
---|---|---|---|
_etag |
string |
Proprietà generata dal sistema che rappresenta l'etag della risorsa necessaria per il controllo della concorrenza ottimistica. |
|
_rid |
string |
Proprietà generata dal sistema. Identificatore univoco. |
|
_ts |
number |
Proprietà generata dal sistema che indica il timestamp dell'ultimo aggiornamento della risorsa. |
|
createMode | Default |
Enumerazione per indicare la modalità di creazione delle risorse. |
|
id |
string |
Nome del database Gremlin di Cosmos DB |
|
restoreParameters |
Parametri per indicare le informazioni sul ripristino |
ResourceRestoreParameters
Parametri per indicare le informazioni sul ripristino.
Nome | Tipo | Descrizione |
---|---|---|
restoreSource |
string |
ID dell'account del database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
restoreTimestampInUtc |
string |
Ora in cui è necessario ripristinare l'account (formato ISO-8601). |