Database Accounts - Get

Service:

Cosmos DB Resource Provider

API Version:

2023-11-15

Recupera le proprietà di un account di database azure Cosmos DB esistente.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
accountName	path	True	string	Nome dell'account del database Cosmos DB. Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
subscriptionId	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	DatabaseAccountGetResults	Le proprietà dell'account di database sono state recuperate correttamente.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	Rappresentare l'account utente

Esempio

CosmosDBDatabaseAccountGet

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1?api-version=2023-11-15

Java

/**
 * Samples for DatabaseAccounts GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/
     * CosmosDBDatabaseAccountGet.json
     */
    /**
     * Sample code: CosmosDBDatabaseAccountGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBDatabaseAccountGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getDatabaseAccounts().getByResourceGroupWithResponse("rg1",
            "ddb1", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

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_database_account_get.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.database_accounts.get(
        resource_group_name="rg1",
        account_name="ddb1",
    )
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountGet.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

Go

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountGet.json
func ExampleDatabaseAccountsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDatabaseAccountsClient().Get(ctx, "rg1", "ddb1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DatabaseAccountGetResults = armcosmos.DatabaseAccountGetResults{
	// 	Name: to.Ptr("ddb1"),
	// 	Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Identity: &armcosmos.ManagedServiceIdentity{
	// 		Type: to.Ptr(armcosmos.ResourceIdentityTypeSystemAssignedUserAssigned),
	// 		PrincipalID: to.Ptr("52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656"),
	// 		TenantID: to.Ptr("33e01921-4d64-4f8c-a055-5bdaffd5e33d"),
	// 		UserAssignedIdentities: map[string]*armcosmos.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
	// 			"/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": &armcosmos.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
	// 				ClientID: to.Ptr("fbe75b66-01c5-4f87-a220-233af3270436"),
	// 				PrincipalID: to.Ptr("33e01921-4d64-4f8c-a055-5bdaffd5e33d"),
	// 			},
	// 		},
	// 	},
	// 	Kind: to.Ptr(armcosmos.DatabaseAccountKindGlobalDocumentDB),
	// 	Properties: &armcosmos.DatabaseAccountGetProperties{
	// 		AnalyticalStorageConfiguration: &armcosmos.AnalyticalStorageConfiguration{
	// 			SchemaType: to.Ptr(armcosmos.AnalyticalStorageSchemaTypeWellDefined),
	// 		},
	// 		APIProperties: &armcosmos.APIProperties{
	// 		},
	// 		BackupPolicy: &armcosmos.PeriodicModeBackupPolicy{
	// 			Type: to.Ptr(armcosmos.BackupPolicyTypePeriodic),
	// 			MigrationState: &armcosmos.BackupPolicyMigrationState{
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-09T21:07:16.000Z"); return t}()),
	// 				Status: to.Ptr(armcosmos.BackupPolicyMigrationStatusInProgress),
	// 				TargetType: to.Ptr(armcosmos.BackupPolicyTypeContinuous),
	// 			},
	// 			PeriodicModeProperties: &armcosmos.PeriodicModeProperties{
	// 				BackupIntervalInMinutes: to.Ptr[int32](240),
	// 				BackupRetentionIntervalInHours: to.Ptr[int32](8),
	// 				BackupStorageRedundancy: to.Ptr(armcosmos.BackupStorageRedundancyGeo),
	// 			},
	// 		},
	// 		ConsistencyPolicy: &armcosmos.ConsistencyPolicy{
	// 			DefaultConsistencyLevel: to.Ptr(armcosmos.DefaultConsistencyLevelSession),
	// 			MaxIntervalInSeconds: to.Ptr[int32](5),
	// 			MaxStalenessPrefix: to.Ptr[int64](100),
	// 		},
	// 		Cors: []*armcosmos.CorsPolicy{
	// 		},
	// 		CreateMode: to.Ptr(armcosmos.CreateModeDefault),
	// 		DatabaseAccountOfferType: to.Ptr("Standard"),
	// 		DefaultIdentity: to.Ptr("FirstPartyIdentity"),
	// 		DisableKeyBasedMetadataWriteAccess: to.Ptr(false),
	// 		DocumentEndpoint: to.Ptr("https://ddb1.documents.azure.com:443/"),
	// 		EnableAnalyticalStorage: to.Ptr(true),
	// 		EnableBurstCapacity: to.Ptr(true),
	// 		EnableFreeTier: to.Ptr(false),
	// 		EnablePartitionMerge: to.Ptr(true),
	// 		FailoverPolicies: []*armcosmos.FailoverPolicy{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-eastus"),
	// 				LocationName: to.Ptr("East US"),
	// 		}},
	// 		InstanceID: to.Ptr("d9b26648-2f53-4541-b3d8-3044f4f9810d"),
	// 		IPRules: []*armcosmos.IPAddressOrRange{
	// 		},
	// 		IsVirtualNetworkFilterEnabled: to.Ptr(false),
	// 		KeysMetadata: &armcosmos.DatabaseAccountKeysMetadata{
	// 			PrimaryMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-25T20:30:11.000Z"); return t}()),
	// 			},
	// 			PrimaryReadonlyMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-25T20:30:11.000Z"); return t}()),
	// 			},
	// 			SecondaryMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-25T20:30:11.000Z"); return t}()),
	// 			},
	// 			SecondaryReadonlyMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-25T20:30:11.000Z"); return t}()),
	// 			},
	// 		},
	// 		Locations: []*armcosmos.Location{
	// 			{
	// 				DocumentEndpoint: to.Ptr("https://ddb1-eastus.documents.azure.com:443/"),
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-eastus"),
	// 				LocationName: to.Ptr("East US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 		}},
	// 		MinimalTLSVersion: to.Ptr(armcosmos.MinimalTLSVersionTLS),
	// 		NetworkACLBypass: to.Ptr(armcosmos.NetworkACLBypassNone),
	// 		NetworkACLBypassResourceIDs: []*string{
	// 		},
	// 		PrivateEndpointConnections: []*armcosmos.PrivateEndpointConnection{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subId/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/account1/privateEndpointConnections/pe1"),
	// 				Properties: &armcosmos.PrivateEndpointConnectionProperties{
	// 					PrivateEndpoint: &armcosmos.PrivateEndpointProperty{
	// 						ID: to.Ptr("/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/pe1"),
	// 					},
	// 					PrivateLinkServiceConnectionState: &armcosmos.PrivateLinkServiceConnectionStateProperty{
	// 						ActionsRequired: to.Ptr("None"),
	// 						Status: to.Ptr("Approved"),
	// 					},
	// 				},
	// 		}},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ReadLocations: []*armcosmos.Location{
	// 			{
	// 				DocumentEndpoint: to.Ptr("https://ddb1-eastus.documents.azure.com:443/"),
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-eastus"),
	// 				LocationName: to.Ptr("East US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 		}},
	// 		VirtualNetworkRules: []*armcosmos.VirtualNetworkRule{
	// 		},
	// 		WriteLocations: []*armcosmos.Location{
	// 			{
	// 				DocumentEndpoint: to.Ptr("https://ddb1-eastus.documents.azure.com:443/"),
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-eastus"),
	// 				LocationName: to.Ptr("East US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 		}},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Retrieves the properties of an existing Azure Cosmos DB database account.
 *
 * @summary Retrieves the properties of an existing Azure Cosmos DB database account.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountGet.json
 */
async function cosmosDbDatabaseAccountGet() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.databaseAccounts.get(resourceGroupName, accountName);
  console.log(result);
}

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

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1",
  "name": "ddb1",
  "location": "West US",
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "kind": "GlobalDocumentDB",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "documentEndpoint": "https://ddb1.documents.azure.com:443/",
    "ipRules": [],
    "isVirtualNetworkFilterEnabled": false,
    "virtualNetworkRules": [],
    "databaseAccountOfferType": "Standard",
    "disableKeyBasedMetadataWriteAccess": false,
    "defaultIdentity": "FirstPartyIdentity",
    "consistencyPolicy": {
      "defaultConsistencyLevel": "Session",
      "maxIntervalInSeconds": 5,
      "maxStalenessPrefix": 100
    },
    "writeLocations": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
        "provisioningState": "Succeeded",
        "failoverPriority": 0
      }
    ],
    "readLocations": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
        "provisioningState": "Succeeded",
        "failoverPriority": 0
      }
    ],
    "locations": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
        "provisioningState": "Succeeded",
        "failoverPriority": 0
      }
    ],
    "failoverPolicies": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "failoverPriority": 0
      }
    ],
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/account1/privateEndpointConnections/pe1",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/pe1"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "actionsRequired": "None"
          }
        }
      }
    ],
    "cors": [],
    "enableFreeTier": false,
    "apiProperties": {},
    "enableAnalyticalStorage": true,
    "enableBurstCapacity": true,
    "analyticalStorageConfiguration": {
      "schemaType": "WellDefined"
    },
    "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d",
    "createMode": "Default",
    "backupPolicy": {
      "type": "Periodic",
      "periodicModeProperties": {
        "backupIntervalInMinutes": 240,
        "backupRetentionIntervalInHours": 8,
        "backupStorageRedundancy": "Geo"
      },
      "migrationState": {
        "status": "InProgress",
        "targetType": "Continuous",
        "startTime": "2021-06-09T21:07:16Z"
      }
    },
    "networkAclBypass": "None",
    "networkAclBypassResourceIds": [],
    "keysMetadata": {
      "primaryMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      },
      "secondaryMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      },
      "primaryReadonlyMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      },
      "secondaryReadonlyMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      }
    },
    "enablePartitionMerge": true,
    "minimalTlsVersion": "Tls"
  },
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "principalId": "52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656",
    "tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d",
    "userAssignedIdentities": {
      "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": "fbe75b66-01c5-4f87-a220-233af3270436",
        "principalId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d"
      }
    }
  }
}

Definizioni

Nome	Descrizione
AccountKeyMetadata	I metadati correlati a una chiave di accesso per un determinato account di database.
AnalyticalStorageConfiguration	Proprietà specifiche dell'archiviazione analitica.
AnalyticalStorageSchemaType	Descrive i tipi di schema per l'archiviazione analitica.
ApiProperties
BackupPolicyMigrationState	Oggetto che rappresenta lo stato della migrazione tra i criteri di backup.
BackupPolicyMigrationStatus	Descrive lo stato della migrazione tra i tipi di criteri di backup.
BackupPolicyType	Descrive la modalità di backup.
BackupStorageRedundancy	Enumerazione per indicare il tipo di ridondanza dell'archiviazione di backup.
Capability	Oggetto funzionalità di Cosmos DB
Capacity	Oggetto che rappresenta tutte le proprietà correlate all'imposizione della capacità in un account.
ConnectorOffer	Tipo di offerta del connettore Cassandra per l'account di database C* di Cosmos DB.
ConsistencyPolicy	Criteri di coerenza per l'account del database Cosmos DB.
ContinuousModeBackupPolicy	Oggetto che rappresenta i criteri di backup in modalità continua.
ContinuousModeProperties	Valori di configurazione per il backup in modalità periodica
ContinuousTier	Enumerazione per indicare il tipo di livello di backup continuo.
CorsPolicy	Criteri CORS per l'account del database Cosmos DB.
createdByType	Tipo di identità che ha creato la risorsa.
CreateMode	Enumerazione per indicare la modalità di creazione dell'account.
DatabaseAccountGetResults	Un account del database Azure Cosmos DB.
DatabaseAccountKeysMetadata	Metadati correlati a ogni chiave di accesso per l'account del database Cosmos DB specificato.
DatabaseAccountKind	Indica il tipo di account del database. Questa impostazione può essere impostata solo in fase di creazione dell'account di database.
DatabaseAccountOfferType	Tipo di offerta per l'account del database Cosmos DB.
DatabaseRestoreResource	Database specifici da ripristinare.
DefaultConsistencyLevel	Impostazioni di configurazione e livello di coerenza predefinite dell'account Cosmos DB.
FailoverPolicy	Criteri di failover per una determinata area di un account di database.
GremlinDatabaseRestoreResource	Database Gremlin specifici da ripristinare.
IpAddressOrRange	Oggetto IpAddressOrRange
Location	Area in cui viene distribuito l'account del database Azure Cosmos DB.
ManagedServiceIdentity	Identità per la risorsa.
MinimalTlsVersion	Indica la versione minima consentita di Tls. Il valore predefinito è Tls 1.2. Le API Cassandra e Mongo funzionano solo con Tls 1.2.
NetworkAclBypass	Indica quali servizi sono autorizzati a ignorare i controlli del firewall.
PeriodicModeBackupPolicy	Oggetto che rappresenta criteri di backup in modalità periodica.
PeriodicModeProperties	Valori di configurazione per il backup in modalità periodica
PrivateEndpointConnection	Una connessione endpoint privato
PrivateEndpointProperty	Endpoint privato a cui appartiene la connessione.
PrivateLinkServiceConnectionStateProperty	Stato connessione della connessione dell'endpoint privato.
PublicNetworkAccess	Indica se le richieste dalla rete pubblica sono consentite
ResourceIdentityType	Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà le identità dal servizio.
RestoreMode	Descrive la modalità di ripristino.
RestoreParameters	Parametri per indicare le informazioni sul ripristino.
ServerVersion	Descrive ServerVersion di un account MongoDB.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
UserAssignedIdentities	Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario identità utente saranno ID risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
VirtualNetworkRule	oggetto Regola ACL Rete virtuale

AccountKeyMetadata

I metadati correlati a una chiave di accesso per un determinato account di database.

Nome	Tipo	Descrizione
generationTime	string	Ora di generazione in formato UTC della chiave in formato ISO-8601. Se il valore manca dall'oggetto, significa che l'ultima rigenerazione della chiave è stata attivata prima del 2022-06-18.

AnalyticalStorageConfiguration

Proprietà specifiche dell'archiviazione analitica.

Nome	Tipo	Descrizione
schemaType	AnalyticalStorageSchemaType	Descrive i tipi di schema per l'archiviazione analitica.

AnalyticalStorageSchemaType

Descrive i tipi di schema per l'archiviazione analitica.

Nome	Tipo	Descrizione
FullFidelity	string
WellDefined	string

ApiProperties

Nome	Tipo	Descrizione
serverVersion	ServerVersion	Descrive ServerVersion di un account MongoDB.

BackupPolicyMigrationState

Oggetto che rappresenta lo stato della migrazione tra i criteri di backup.

Nome	Tipo	Descrizione
startTime	string	Ora in cui è stata avviata la migrazione dei criteri di backup (formato ISO-8601).
status	BackupPolicyMigrationStatus	Descrive lo stato della migrazione tra i tipi di criteri di backup.
targetType	BackupPolicyType	Descrive il tipo di criterio di backup di destinazione della migrazione dei criteri di backup.

BackupPolicyMigrationStatus

Descrive lo stato della migrazione tra i tipi di criteri di backup.

Nome	Tipo	Descrizione
Completed	string
Failed	string
InProgress	string
Invalid	string

BackupPolicyType

Descrive la modalità di backup.

Nome	Tipo	Descrizione
Continuous	string
Periodic	string

BackupStorageRedundancy

Enumerazione per indicare il tipo di ridondanza dell'archiviazione di backup.

Nome	Tipo	Descrizione
Geo	string
Local	string
Zone	string

Capability

Oggetto funzionalità di Cosmos DB

Nome	Tipo	Descrizione
name	string	Nome della funzionalità di Cosmos DB. Ad esempio, "name": "EnableCassandra". I valori correnti includono anche "EnableTable" e "EnableGremlin".

Capacity

Oggetto che rappresenta tutte le proprietà correlate all'imposizione della capacità in un account.

Nome	Tipo	Descrizione
totalThroughputLimit	integer	Limite totale di velocità effettiva imposto all'account. Un totaleThroughputLimit di 2000 impone un limite rigoroso di velocità effettiva massima di cui è possibile effettuare il provisioning su tale account per essere 2000. Un totaleThroughputLimit di -1 indica che non sono previsti limiti al provisioning della velocità effettiva.

ConnectorOffer

Tipo di offerta del connettore Cassandra per l'account di database C* di Cosmos DB.

Nome	Tipo	Descrizione
Small	string

ConsistencyPolicy

Criteri di coerenza per l'account del database Cosmos DB.

Nome	Tipo	Descrizione
defaultConsistencyLevel	DefaultConsistencyLevel	Impostazioni di configurazione e livello di coerenza predefinite dell'account Cosmos DB.
maxIntervalInSeconds	integer	Se usato con il livello di coerenza decadimento ristretto, questo valore rappresenta la quantità di tempo di decadimento (in secondi) tollerata. L'intervallo accettato per questo valore è 5 - 86400. Obbligatorio quando defaultConsistencyPolicy è impostato su "BoundedStaleness".
maxStalenessPrefix	integer	Se usato con il livello di coerenza decadimento ristretto, questo valore rappresenta il numero di richieste non aggiornate tollerate. L'intervallo consentito per questo valore è compreso tra 1 e 2.147.483.647. Obbligatorio quando defaultConsistencyPolicy è impostato su "BoundedStaleness".

ContinuousModeBackupPolicy

Oggetto che rappresenta i criteri di backup in modalità continua.

Nome	Tipo	Descrizione
continuousModeProperties	ContinuousModeProperties	Valori di configurazione per il backup in modalità continua
migrationState	BackupPolicyMigrationState	Oggetto che rappresenta lo stato della migrazione tra i criteri di backup.
type	string: Continuous	Descrive la modalità di backup.

ContinuousModeProperties

Valori di configurazione per il backup in modalità periodica

Nome	Tipo	Descrizione
tier	ContinuousTier	Enumerazione per indicare il tipo di modalità di backup continua

ContinuousTier

Enumerazione per indicare il tipo di livello di backup continuo.

Nome	Tipo	Descrizione
Continuous30Days	string
Continuous7Days	string

CorsPolicy

Criteri CORS per l'account del database Cosmos DB.

Nome	Tipo	Descrizione
allowedHeaders	string	le intestazioni di richiesta che possono essere specificate dal dominio di origine nella richiesta CORS.
allowedMethods	string	i metodi (verbi di richiesta HTTP) che possono essere usati dal dominio di origine per una richiesta CORS.
allowedOrigins	string	Domini di origine autorizzati a effettuare una richiesta al servizio tramite CORS.
exposedHeaders	string	le intestazioni di risposta che possono essere inviate in risposta alla richiesta CORS ed esposte all'emittente della richiesta dal browser.
maxAgeInSeconds	integer	la quantità di tempo massima in cui la richiesta preliminare OPTIONS deve essere memorizzata nella cache di un browser.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

Enumerazione per indicare la modalità di creazione dell'account.

Nome	Tipo	Descrizione
Default	string
Restore	string

DatabaseAccountGetResults

Un account del database Azure Cosmos DB.

Nome	Tipo	Valore predefinito	Descrizione
id	string		Identificatore univoco della risorsa arm.
identity	ManagedServiceIdentity		Identità per la risorsa.
kind	DatabaseAccountKind	GlobalDocumentDB	Indica il tipo di account del database. Questa impostazione può essere impostata solo in fase di creazione dell'account di database.
location	string		Posizione del gruppo di risorse a cui appartiene la risorsa.
name	string		Nome della risorsa arm.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		Proprietà specifiche dell'archiviazione analitica.
properties.apiProperties	ApiProperties		Proprietà specifiche dell'API.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy		Oggetto che rappresenta i criteri per l'esecuzione dei backup in un account.
properties.capabilities	Capability[]		Elenco delle funzionalità di Cosmos DB per l'account
properties.capacity	Capacity		Oggetto che rappresenta tutte le proprietà correlate all'imposizione della capacità in un account.
properties.connectorOffer	ConnectorOffer		Tipo di offerta del connettore cassandra per l'account C* del database Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy		Criteri di coerenza per l'account del database Cosmos DB.
properties.cors	CorsPolicy[]		Criteri CORS per l'account del database Cosmos DB.
properties.createMode	CreateMode	Default	Enumerazione per indicare la modalità di creazione dell'account.
properties.customerManagedKeyStatus	string		Indica lo stato della funzionalità Chiave gestita dal cliente nell'account. In caso di errori, la proprietà fornisce indicazioni per la risoluzione dei problemi.
properties.databaseAccountOfferType	DatabaseAccountOfferType		Tipo di offerta per l'account del database Cosmos DB. Valore predefinito: Standard.
properties.defaultIdentity	string		Identità predefinita per l'accesso all'insieme di credenziali delle chiavi usato in funzionalità come le chiavi gestite dal cliente. L'identità predefinita deve essere impostata in modo esplicito dagli utenti. Può essere "FirstPartyIdentity", "SystemAssignedIdentity" e altro ancora.
properties.disableKeyBasedMetadataWriteAccess	boolean		Disabilitare le operazioni di scrittura sulle risorse dei metadati (database, contenitori, velocità effettiva) tramite chiavi dell'account
properties.disableLocalAuth	boolean		Rifiutare esplicitamente l'autenticazione locale e assicurarsi che solo MSI e AAD possano essere usati esclusivamente per l'autenticazione.
properties.documentEndpoint	string		Endpoint di connessione per l'account del database Cosmos DB.
properties.enableAnalyticalStorage	boolean		Flag per indicare se abilitare l'analisi dell'archiviazione.
properties.enableAutomaticFailover	boolean		Abilita il failover automatico dell'area di scrittura nel raro caso in cui l'area non sia disponibile a causa di un'interruzione del servizio. Il failover automatico comporterà una nuova area di scrittura per l'account e viene scelta in base alle priorità di failover configurate per l'account.
properties.enableBurstCapacity	boolean		Flag per indicare l'abilitazione/disabilitazione della funzionalità Anteprima capacità burst nell'account
properties.enableCassandraConnector	boolean		Abilita il connettore cassandra nell'account C* di Cosmos DB
properties.enableFreeTier	boolean		Flag per indicare se il livello gratuito è abilitato.
properties.enableMultipleWriteLocations	boolean		Consente all'account di scrivere in più posizioni
properties.enablePartitionMerge	boolean		Flag per indicare l'abilitazione/disabilitazione della funzionalità Merge partizione nell'account
properties.failoverPolicies	FailoverPolicy[]		Matrice che contiene le aree ordinate in base alle priorità di failover.
properties.instanceId	string		Identificatore univoco assegnato all'account del database
properties.ipRules	IpAddressOrRange[]		Elenco di IpRules.
properties.isVirtualNetworkFilterEnabled	boolean		Flag per indicare se abilitare/disabilitare Rete virtuale regole ACL.
properties.keyVaultKeyUri	string		URI dell'insieme di credenziali delle chiavi
properties.keysMetadata	DatabaseAccountKeysMetadata		Oggetto che rappresenta i metadati per le chiavi dell'account Cosmos DB.
properties.locations	Location[]		Matrice che contiene tutte le posizioni abilitate per l'account Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion		Indica la versione minima consentita di Tls. Il valore predefinito è Tls 1.2. Le API Cassandra e Mongo funzionano solo con Tls 1.2.
properties.networkAclBypass	NetworkAclBypass		Indica quali servizi sono autorizzati a ignorare i controlli del firewall.
properties.networkAclBypassResourceIds	string[]		Matrice che contiene gli ID risorsa per il bypass Acl di rete per l'account Cosmos DB.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Elenco di Connections endpoint privato configurato per l'account Cosmos DB.
properties.provisioningState	string		Stato dell'account Cosmos DB al momento della chiamata dell'operazione. Lo stato può essere uno dei seguenti. 'Creazione': viene creato l'account Cosmos DB. Quando un account è in Stato di creazione, vengono restituite solo le proprietà specificate come input per l'operazione Crea account Cosmos DB. 'Succeeded': l'account Cosmos DB è attivo per l'uso. 'Aggiornamento': l'account Cosmos DB viene aggiornato. 'Eliminazione': l'account Cosmos DB viene eliminato. 'Failed': creazione dell'account Cosmos DB non riuscita. 'DeletionFailed': l'eliminazione dell'account Cosmos DB non è riuscita.
properties.publicNetworkAccess	PublicNetworkAccess		Indica se le richieste dalla rete pubblica sono consentite
properties.readLocations	Location[]		Matrice che contiene i percorsi di lettura abilitati per l'account Cosmos DB.
properties.restoreParameters	RestoreParameters		Parametri per indicare le informazioni sul ripristino.
properties.virtualNetworkRules	VirtualNetworkRule[]		Elenco delle regole ACL Rete virtuale configurate per l'account Cosmos DB.
properties.writeLocations	Location[]		Matrice che contiene il percorso di scrittura per l'account Cosmos DB.
systemData	systemData		Metadati di sistema relativi a questa risorsa.
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.

DatabaseAccountKeysMetadata

Metadati correlati a ogni chiave di accesso per l'account del database Cosmos DB specificato.

Nome	Tipo	Descrizione
primaryMasterKey	AccountKeyMetadata	Metadati correlati alla chiave Read-Write primaria per l'account del database Cosmos DB specificato.
primaryReadonlyMasterKey	AccountKeyMetadata	Metadati correlati alla chiave Read-Only primaria per l'account del database Cosmos DB specificato.
secondaryMasterKey	AccountKeyMetadata	Metadati correlati alla chiave di Read-Write secondaria per l'account del database Cosmos DB specificato.
secondaryReadonlyMasterKey	AccountKeyMetadata	Metadati correlati alla chiave di Read-Only secondaria per l'account del database Cosmos DB specificato.

DatabaseAccountKind

Indica il tipo di account del database. Questa impostazione può essere impostata solo in fase di creazione dell'account di database.

Nome	Tipo	Descrizione
GlobalDocumentDB	string
MongoDB	string
Parse	string

DatabaseAccountOfferType

Tipo di offerta per l'account del database Cosmos DB.

Nome	Tipo	Descrizione
Standard	string

DatabaseRestoreResource

Database specifici da ripristinare.

Nome	Tipo	Descrizione
collectionNames	string[]	Nomi delle raccolte disponibili per il ripristino.
databaseName	string	Nome del database disponibile per il ripristino.

DefaultConsistencyLevel

Impostazioni di configurazione e livello di coerenza predefinite dell'account Cosmos DB.

Nome	Tipo	Descrizione
BoundedStaleness	string
ConsistentPrefix	string
Eventual	string
Session	string
Strong	string

FailoverPolicy

Criteri di failover per una determinata area di un account di database.

Nome	Tipo	Descrizione
failoverPriority	integer	Priorità di failover dell'area. Una priorità di failover pari a 0 indica un'area di scrittura. Valore massimo per una priorità di failover = (numero totale di aree - 1). I valori di priorità di failover devono essere univoci per ogni area in cui è presente l'account del database.
id	string	Identificatore univoco dell'area in cui viene replicato l'account del database. Esempio: <accountName-locationName>><.
locationName	string	Nome dell'area in cui è presente l'account del database.

GremlinDatabaseRestoreResource

Database Gremlin specifici da ripristinare.

Nome	Tipo	Descrizione
databaseName	string	Nome del database gremlin disponibile per il ripristino.
graphNames	string[]	Nomi dei grafici disponibili per il ripristino.

IpAddressOrRange

Oggetto IpAddressOrRange

Nome	Tipo	Descrizione
ipAddressOrRange	string	Un singolo indirizzo IPv4 o un singolo intervallo di indirizzi IPv4 in formato CIDR. Gli indirizzi IP forniti devono essere formattati correttamente e non possono essere contenuti in uno degli intervalli seguenti: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, perché non sono applicabili dal filtro indirizzi IP. Esempio di input validi: "23.40.210.245" o "23.40.210.0/8".

Location

Area in cui viene distribuito l'account del database Azure Cosmos DB.

Nome	Tipo	Descrizione
documentEndpoint	string	Endpoint di connessione per l'area specifica. Esempio: https://< accountName-locationName.documents.azure.com:443/><>
failoverPriority	integer	Priorità di failover dell'area. Una priorità di failover pari a 0 indica un'area di scrittura. Valore massimo per una priorità di failover = (numero totale di aree - 1). I valori di priorità di failover devono essere univoci per ogni area in cui è presente l'account del database.
id	string	Identificatore univoco dell'area all'interno dell'account del database. Esempio: <accountName-locationName>><.
isZoneRedundant	boolean	Flag per indicare se questa area è un'area AvailabilityZone
locationName	string	Il nome dell'area.
provisioningState	string	Stato dell'account Cosmos DB al momento della chiamata dell'operazione. Lo stato può essere uno dei seguenti. 'Creazione': viene creato l'account Cosmos DB. Quando un account è in Stato di creazione, vengono restituite solo le proprietà specificate come input per l'operazione Crea account Cosmos DB. 'Succeeded': l'account Cosmos DB è attivo per l'uso. 'Aggiornamento': l'account Cosmos DB viene aggiornato. 'Eliminazione': l'account Cosmos DB viene eliminato. 'Failed': creazione dell'account Cosmos DB non riuscita. 'DeletionFailed': l'eliminazione dell'account Cosmos DB non è riuscita.

ManagedServiceIdentity

Identità per la risorsa.

Nome	Tipo	Descrizione
principalId	string	ID dell'entità dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.
tenantId	string	ID tenant dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.
type	ResourceIdentityType	Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà le identità dal servizio.
userAssignedIdentities	UserAssignedIdentities	Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario identità utente saranno ID risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

MinimalTlsVersion

Indica la versione minima consentita di Tls. Il valore predefinito è Tls 1.2. Le API Cassandra e Mongo funzionano solo con Tls 1.2.

Nome	Tipo	Descrizione
Tls	string
Tls11	string
Tls12	string

NetworkAclBypass

Indica quali servizi sono autorizzati a ignorare i controlli del firewall.

Nome	Tipo	Descrizione
AzureServices	string
None	string

PeriodicModeBackupPolicy

Oggetto che rappresenta criteri di backup in modalità periodica.

Nome	Tipo	Descrizione
migrationState	BackupPolicyMigrationState	Oggetto che rappresenta lo stato della migrazione tra i criteri di backup.
periodicModeProperties	PeriodicModeProperties	Valori di configurazione per il backup in modalità periodica
type	string: Periodic	Descrive la modalità di backup.

PeriodicModeProperties

Valori di configurazione per il backup in modalità periodica

Nome	Tipo	Descrizione
backupIntervalInMinutes	integer	Intero che rappresenta l'intervallo in minuti tra due backup
backupRetentionIntervalInHours	integer	Intero che rappresenta l'ora (in ore) che ogni backup viene mantenuto
backupStorageRedundancy	BackupStorageRedundancy	Enumerazione per indicare il tipo di residenza di backup

PrivateEndpointConnection

Una connessione endpoint privato

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nome della risorsa.
properties.groupId	string	ID gruppo dell'endpoint privato.
properties.privateEndpoint	PrivateEndpointProperty	Endpoint privato a cui appartiene la connessione.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Stato connessione della connessione dell'endpoint privato.
properties.provisioningState	string	Stato di provisioning dell'endpoint privato.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

Endpoint privato a cui appartiene la connessione.

Nome	Tipo	Descrizione
id	string	ID risorsa dell'endpoint privato.

PrivateLinkServiceConnectionStateProperty

Stato connessione della connessione dell'endpoint privato.

Nome	Tipo	Descrizione
actionsRequired	string	Qualsiasi azione necessaria oltre al flusso di lavoro di base (approvazione/rifiuto/disconnessione)
description	string	Descrizione della connessione al servizio di collegamento privato.
status	string	Stato della connessione al servizio di collegamento privato.

PublicNetworkAccess

Indica se le richieste dalla rete pubblica sono consentite

Nome	Tipo	Descrizione
Disabled	string
Enabled	string
SecuredByPerimeter	string

ResourceIdentityType

Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà le identità dal servizio.

Nome	Tipo	Descrizione
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

RestoreMode

Descrive la modalità di ripristino.

Nome	Tipo	Descrizione
PointInTime	string

RestoreParameters

Parametri per indicare le informazioni sul ripristino.

Nome	Tipo	Descrizione
databasesToRestore	DatabaseRestoreResource[]	Elenco di database specifici disponibili per il ripristino.
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	Elenco di database gremlin specifici disponibili per il ripristino.
restoreMode	RestoreMode	Descrive la modalità di ripristino.
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).
tablesToRestore	string[]	Elenco di tabelle specifiche disponibili per il ripristino.

ServerVersion

Descrive ServerVersion di un account MongoDB.

Nome	Tipo	Descrizione
3.2	string
3.6	string
4.0	string
4.2	string

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

UserAssignedIdentities

Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario identità utente saranno ID risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Nome	Tipo	Descrizione

VirtualNetworkRule

oggetto Regola ACL Rete virtuale

Nome	Tipo	Descrizione
id	string	ID risorsa di una subnet, ad esempio: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignoreMissingVNetServiceEndpoint	boolean	Creare una regola del firewall prima che la rete virtuale disponga dell'endpoint servizio di rete virtuale abilitato.