Database Accounts - List By Resource Group

Referencia

Service:: Cosmos DB Resource Provider

API Version:: 2023-11-15

Listák az adott erőforráscsoportban elérhető összes Azure Cosmos DB-adatbázisfiókot.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	DatabaseAccountsListResult	A művelet sikeresen befejeződött.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	A felhasználói fiók megszemélyesítése

Példák

CosmosDBDatabaseAccountListByResourceGroup

Sample Request

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

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_list_by_resource_group.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.list_by_resource_group(
        resource_group_name="rg1",
    )
    for item in response:
        print(item)


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

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/CosmosDBDatabaseAccountListByResourceGroup.json
func ExampleDatabaseAccountsClient_NewListByResourceGroupPager() {
	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)
	}
	pager := clientFactory.NewDatabaseAccountsClient().NewListByResourceGroupPager("rg1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DatabaseAccountsListResult = armcosmos.DatabaseAccountsListResult{
		// 	Value: []*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{
		// 				ConsistencyPolicy: &armcosmos.ConsistencyPolicy{
		// 					DefaultConsistencyLevel: to.Ptr(armcosmos.DefaultConsistencyLevelSession),
		// 					MaxIntervalInSeconds: to.Ptr[int32](5),
		// 					MaxStalenessPrefix: to.Ptr[int64](100),
		// 				},
		// 				Cors: []*armcosmos.CorsPolicy{
		// 				},
		// 				DatabaseAccountOfferType: to.Ptr("Standard"),
		// 				DefaultIdentity: to.Ptr("FirstPartyIdentity"),
		// 				DisableKeyBasedMetadataWriteAccess: to.Ptr(false),
		// 				DocumentEndpoint: to.Ptr("https://ddb1.documents.azure.com:443/"),
		// 				EnableFreeTier: to.Ptr(false),
		// 				FailoverPolicies: []*armcosmos.FailoverPolicy{
		// 					{
		// 						FailoverPriority: to.Ptr[int32](0),
		// 						ID: to.Ptr("ddb1-eastus"),
		// 						LocationName: to.Ptr("East US"),
		// 				}},
		// 				IPRules: []*armcosmos.IPAddressOrRange{
		// 				},
		// 				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{
		// 				},
		// 				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"),
		// 				}},
		// 				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

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

/**
 * This sample demonstrates how to Lists all the Azure Cosmos DB database accounts available under the given resource group.
 *
 * @summary Lists all the Azure Cosmos DB database accounts available under the given resource group.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountListByResourceGroup.json
 */
async function cosmosDbDatabaseAccountListByResourceGroup() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.databaseAccounts.listByResourceGroup(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

{
  "value": [
    {
      "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": [],
        "databaseAccountOfferType": "Standard",
        "disableKeyBasedMetadataWriteAccess": false,
        "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
          }
        ],
        "cors": [],
        "enableFreeTier": false,
        "defaultIdentity": "FirstPartyIdentity",
        "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"
          }
        },
        "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"
          }
        }
      }
    }
  ]
}

Definíciók

Name	Description
AccountKeyMetadata	Az adott adatbázisfiók hozzáférési kulcsához kapcsolódó metaadatok.
AnalyticalStorageConfiguration	Elemzési tár specifikus tulajdonságai.
AnalyticalStorageSchemaType	Az elemzési tár sématípusait ismerteti.
ApiProperties
BackupPolicyMigrationState	A biztonsági mentési szabályzatok közötti migrálás állapotát jelölő objektum.
BackupPolicyMigrationStatus	A biztonsági mentési házirendek típusai közötti migrálás állapotát ismerteti.
BackupPolicyType	A biztonsági mentések módját ismerteti.
BackupStorageRedundancy	Enumerálás a biztonsági mentési tár redundanciájának típusának jelzéséhez.
Capability	Cosmos DB képességobjektum
Capacity	A fiók kapacitáskényszerítéséhez kapcsolódó összes tulajdonságot képviselő objektum.
ConnectorOffer	A Cassandra-összekötő ajánlattípusa a Cosmos DB C* adatbázisfiókhoz.
ConsistencyPolicy	A Cosmos DB-adatbázisfiók konzisztenciaszabályzata.
ContinuousModeBackupPolicy	A folyamatos módú biztonsági mentési szabályzatot képviselő objektum.
ContinuousModeProperties	A rendszeres módú biztonsági mentés konfigurációs értékei
ContinuousTier	Enumerálás a folyamatos biztonsági mentési szint típusának jelzéséhez.
CorsPolicy	A Cosmos DB-adatbázisfiók CORS-szabályzata.
createdByType	Az erőforrást létrehozó identitás típusa.
CreateMode	Enumerálás a fióklétrehozás módjának jelzésére.
DatabaseAccountGetResults	Egy Azure Cosmos DB-adatbázisfiók.
DatabaseAccountKeysMetadata	Az adott Cosmos DB-adatbázisfiók minden hozzáférési kulcsához kapcsolódó metaadatok.
DatabaseAccountKind	Az adatbázisfiók típusát jelzi. Ez csak adatbázisfiók létrehozásakor állítható be.
DatabaseAccountOfferType	A Cosmos DB-adatbázisfiók ajánlattípusa.
DatabaseAccountsListResult	A List művelet válasza, amely tartalmazza az adatbázisfiókokat és azok tulajdonságait.
DatabaseRestoreResource	Adott visszaállítandó adatbázisok.
DefaultConsistencyLevel	A Cosmos DB-fiók alapértelmezett konzisztenciaszintje és konfigurációs beállításai.
FailoverPolicy	Az adatbázisfiók adott régiójára vonatkozó feladatátvételi szabályzat.
GremlinDatabaseRestoreResource	Adott gremlin-adatbázisok visszaállítása.
IpAddressOrRange	IpAddressOrRange objektum
Location	Egy régió, amelyben az Azure Cosmos DB-adatbázisfiók üzembe lett helyezve.
ManagedServiceIdentity	Az erőforrás identitása.
MinimalTlsVersion	A minimálisan engedélyezett TLS-verziót jelzi. Az alapértelmezett érték a Tls 1.2. A Cassandra és a Mongo API-k csak a Tls 1.2-vel működnek.
NetworkAclBypass	Azt jelzi, hogy mely szolgáltatások kerülhetik meg a tűzfalellenőrzéseket.
PeriodicModeBackupPolicy	Az időszakos módú biztonsági mentési szabályzatot képviselő objektum.
PeriodicModeProperties	A rendszeres módú biztonsági mentés konfigurációs értékei
PrivateEndpointConnection	Privát végponti kapcsolat
PrivateEndpointProperty	Privát végpont, amelyhez a kapcsolat tartozik.
PrivateLinkServiceConnectionStateProperty	A privát végponti kapcsolat kapcsolati állapota.
PublicNetworkAccess	Engedélyezve vannak-e a nyilvános hálózatról érkező kérések
ResourceIdentityType	Az erőforráshoz használt identitás típusa. A "SystemAssigned,UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból.
RestoreMode	A visszaállítás módját ismerteti.
RestoreParameters	A visszaállítással kapcsolatos információkat jelző paraméterek.
ServerVersion	Egy MongoDB-fiók ServerVersion függvényét ismerteti.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
UserAssignedIdentities	Az erőforráshoz társított felhasználói identitások listája. A felhasználói identitás szótárkulcs-hivatkozásai ARM-erőforrásazonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".
VirtualNetworkRule	ACL-szabályobjektum Virtual Network

AccountKeyMetadata

Az adott adatbázisfiók hozzáférési kulcsához kapcsolódó metaadatok.

Name	Típus	Description
generationTime	string	A kulcs LÉTREHOZÁSI ideje (UTC) ISO-8601 formátumban. Ha az érték hiányzik az objektumból, az azt jelenti, hogy az utolsó kulcs újragenerálása 2022.06.18. előtt aktiválódott.

AnalyticalStorageConfiguration

Elemzési tár specifikus tulajdonságai.

Name	Típus	Description
schemaType	AnalyticalStorageSchemaType	Az elemzési tár sématípusait ismerteti.

AnalyticalStorageSchemaType

Az elemzési tár sématípusait ismerteti.

Name	Típus	Description
FullFidelity	string
WellDefined	string

ApiProperties

Name	Típus	Description
serverVersion	ServerVersion	Egy MongoDB-fiók ServerVersion függvényét ismerteti.

BackupPolicyMigrationState

A biztonsági mentési szabályzatok közötti migrálás állapotát jelölő objektum.

Name	Típus	Description
startTime	string	A biztonsági mentési szabályzat migrálásának kezdete (ISO-8601 formátum).
status	BackupPolicyMigrationStatus	A biztonsági mentési házirendek típusai közötti migrálás állapotát ismerteti.
targetType	BackupPolicyType	A biztonsági mentési szabályzat áttelepítésének célként megadott biztonsági mentési szabályzattípusát ismerteti.

BackupPolicyMigrationStatus

A biztonsági mentési házirendek típusai közötti migrálás állapotát ismerteti.

Name	Típus	Description
Completed	string
Failed	string
InProgress	string
Invalid	string

BackupPolicyType

A biztonsági mentések módját ismerteti.

Name	Típus	Description
Continuous	string
Periodic	string

BackupStorageRedundancy

Enumerálás a biztonsági mentési tár redundanciájának típusának jelzéséhez.

Name	Típus	Description
Geo	string
Local	string
Zone	string

Capability

Cosmos DB képességobjektum

Name	Típus	Description
name	string	A Cosmos DB-képesség neve. Például: "name": "EnableCassandra". Az aktuális értékek közé tartozik az "EnableTable" és az "EnableGremlin" is.

Capacity

A fiók kapacitáskényszerítéséhez kapcsolódó összes tulajdonságot képviselő objektum.

Name	Típus	Description
totalThroughputLimit	integer	A fiókra vonatkozó teljes átviteli sebességkorlát. A totalThroughputLimit of 2000 szigorú maximális átviteli sebességet ír elő, amely az adott fiókban 2000-nek adható ki. A totalThroughputLimit of -1 azt jelzi, hogy nincs korlátozva az átviteli sebesség kiosztása.

ConnectorOffer

A Cassandra-összekötő ajánlattípusa a Cosmos DB C* adatbázisfiókhoz.

Name	Típus	Description
Small	string

ConsistencyPolicy

A Cosmos DB-adatbázisfiók konzisztenciaszabályzata.

Name	Típus	Description
defaultConsistencyLevel	DefaultConsistencyLevel	A Cosmos DB-fiók alapértelmezett konzisztenciaszintje és konfigurációs beállításai.
maxIntervalInSeconds	integer	Ha a Kötött frissesség konzisztenciaszinttel használja, ez az érték az elavultság időmennyiségét (másodpercben) jelzi. Ennek az értéknek az elfogadott tartománya 5–86400. Kötelező, ha a defaultConsistencyPolicy értéke "BoundedStaleness".
maxStalenessPrefix	integer	Ha a Bounded Staleness konzisztenciaszinttel használja, ez az érték az elavult kérések tolerált számát jelöli. Ennek az értéknek az elfogadott tartománya 1 – 2 147 483 647. Kötelező, ha a defaultConsistencyPolicy értéke "BoundedStaleness".

ContinuousModeBackupPolicy

A folyamatos módú biztonsági mentési szabályzatot képviselő objektum.

Name	Típus	Description
continuousModeProperties	ContinuousModeProperties	Konfigurációs értékek a folyamatos módú biztonsági mentéshez
migrationState	BackupPolicyMigrationState	A biztonsági mentési szabályzatok közötti migrálás állapotát jelölő objektum.
type	string: Continuous	A biztonsági mentések módját ismerteti.

ContinuousModeProperties

A rendszeres módú biztonsági mentés konfigurációs értékei

Name	Típus	Description
tier	ContinuousTier	Enumerálás a folyamatos biztonsági mentési mód típusának jelzéséhez

ContinuousTier

Enumerálás a folyamatos biztonsági mentési szint típusának jelzéséhez.

Name	Típus	Description
Continuous30Days	string
Continuous7Days	string

CorsPolicy

A Cosmos DB-adatbázisfiók CORS-szabályzata.

Name	Típus	Description
allowedHeaders	string	A kérésfejlécek, amelyeket a forrástartomány megadhat a CORS-kérelemben.
allowedMethods	string	Azok a metódusok (HTTP-kérési parancsok), amelyeket a forrástartomány a CORS-kérelmekhez használhat.
allowedOrigins	string	Azok a forrástartományok, amelyek a CORS-on keresztül kérhetik a szolgáltatást.
exposedHeaders	string	A CORS-kérelemre adott válaszban elküldhető válaszfejlécek, amelyeket a böngésző elérhetővé tehet a kérés kiállítójának.
maxAgeInSeconds	integer	Az az időtartam, amellyel a böngészőnek gyorsítótáraznia kell az elővizsgálati BEÁLLÍTÁSOK kérést.

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

Enumerálás a fióklétrehozás módjának jelzésére.

Name	Típus	Description
Default	string
Restore	string

DatabaseAccountGetResults

Egy Azure Cosmos DB-adatbázisfiók.

Name	Típus	Alapértelmezett érték	Description
id	string		Az ARM-erőforrás egyedi erőforrás-azonosítója.
identity	ManagedServiceIdentity		Az erőforrás identitása.
kind	DatabaseAccountKind	GlobalDocumentDB	Az adatbázisfiók típusát jelzi. Ez csak adatbázisfiók létrehozásakor állítható be.
location	string		Annak az erőforráscsoportnak a helye, amelyhez az erőforrás tartozik.
name	string		Az ARM-erőforrás neve.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		Elemzési tár specifikus tulajdonságai.
properties.apiProperties	ApiProperties		API-specifikus tulajdonságok.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy		A biztonsági mentések fiókon történő készítésére vonatkozó szabályzatot képviselő objektum.
properties.capabilities	Capability[]		A cosmos DB-képességek listája a fiókhoz
properties.capacity	Capacity		A fiók kapacitáskényszerítéséhez kapcsolódó összes tulajdonságot képviselő objektum.
properties.connectorOffer	ConnectorOffer		A Cassandra-összekötő ajánlattípusa a Cosmos DB-adatbázis C* fiókjához.
properties.consistencyPolicy	ConsistencyPolicy		A Cosmos DB-adatbázisfiók konzisztenciaszabályzata.
properties.cors	CorsPolicy[]		A Cosmos DB-adatbázisfiók CORS-szabályzata.
properties.createMode	CreateMode	Default	Enumerálás a fióklétrehozás módjának jelzésére.
properties.customerManagedKeyStatus	string		A fiók Ügyfél által felügyelt kulcs funkciójának állapotát jelzi. Hibák esetén a tulajdonság hibaelhárítási útmutatást nyújt.
properties.databaseAccountOfferType	DatabaseAccountOfferType		A Cosmos DB-adatbázisfiók ajánlattípusa. Alapértelmezett érték: Standard.
properties.defaultIdentity	string		A kulcstartóhoz való hozzáférés alapértelmezett identitása, amelyet olyan funkciók használnak, mint az ügyfél által kezelt kulcsok. Az alapértelmezett identitást a felhasználóknak explicit módon kell beállítaniuk. Ez lehet "FirstPartyIdentity", "SystemAssignedIdentity" és még sok más.
properties.disableKeyBasedMetadataWriteAccess	boolean		A metaadat-erőforrások (adatbázisok, tárolók, átviteli sebesség) írási műveleteinek letiltása fiókkulcsokkal
properties.disableLocalAuth	boolean		Tiltsa le a helyi hitelesítést, és győződjön meg arról, hogy kizárólag az MSI és az AAD használható kizárólag hitelesítéshez.
properties.documentEndpoint	string		A Cosmos DB-adatbázisfiók kapcsolati végpontja.
properties.enableAnalyticalStorage	boolean		Jelző, amely jelzi, hogy engedélyezni kívánja-e a tárolóelemzést.
properties.enableAutomaticFailover	boolean		Lehetővé teszi az írási régió automatikus feladatátvételét abban a ritka esetben, ha a régió szolgáltatáskimaradás miatt nem érhető el. Az automatikus feladatátvétel új írási régiót eredményez a fiókhoz, és a fiókhoz konfigurált feladatátvételi prioritások alapján lesz kiválasztva.
properties.enableBurstCapacity	boolean		Jelző a kapacitáscsúcs előzetes verziójának engedélyezését/letiltását jelzi a fiókon
properties.enableCassandraConnector	boolean		Engedélyezi a Cassandra-összekötőt a Cosmos DB C* fiókon
properties.enableFreeTier	boolean		Jelző, amely jelzi, hogy az ingyenes szint engedélyezve van-e.
properties.enableMultipleWriteLocations	boolean		Lehetővé teszi, hogy a fiók több helyen írjon
properties.enablePartitionMerge	boolean		A fiók partícióegyesítési funkciójának engedélyezését/letiltását jelző jelző
properties.failoverPolicies	FailoverPolicy[]		Egy tömb, amely a feladatátvételi prioritások szerint rendezett régiókat tartalmazza.
properties.instanceId	string		Az adatbázisfiókhoz rendelt egyedi azonosító
properties.ipRules	IpAddressOrRange[]		IpRules-lista.
properties.isVirtualNetworkFilterEnabled	boolean		Jelölő, amely jelzi, hogy engedélyezni/letiltani Virtual Network ACL-szabályokat.
properties.keyVaultKeyUri	string		A kulcstartó URI-ja
properties.keysMetadata	DatabaseAccountKeysMetadata		A Cosmos DB-fiók fiókkulcsainak metaadatait képviselő objektum.
properties.locations	Location[]		Egy tömb, amely a Cosmos DB-fiókhoz engedélyezett összes helyet tartalmazza.
properties.minimalTlsVersion	MinimalTlsVersion		A minimálisan engedélyezett TLS-verziót jelzi. Az alapértelmezett érték a Tls 1.2. A Cassandra és a Mongo API-k csak a Tls 1.2-vel működnek.
properties.networkAclBypass	NetworkAclBypass		Azt jelzi, hogy mely szolgáltatások kerülhetik meg a tűzfalellenőrzéseket.
properties.networkAclBypassResourceIds	string[]		Egy tömb, amely a Cosmos DB-fiók Hálózati Acl Bypass erőforrás-azonosítóit tartalmazza.
properties.privateEndpointConnections	PrivateEndpointConnection[]		A Cosmos DB-fiókhoz konfigurált privát végpontok listája Connections.
properties.provisioningState	string		A Cosmos DB-fiók állapota a művelet meghívásának időpontjában. Az állapot az alábbiak egyike lehet. "Létrehozás" – a Cosmos DB-fiók létrehozása folyamatban van. Ha egy fiók Létrehozás állapotban van, a rendszer csak a Cosmos DB-fiók létrehozása művelet bemeneteként megadott tulajdonságokat adja vissza. "Sikeres" – a Cosmos DB-fiók használatban van. "Frissítés" – a Cosmos DB-fiók frissítése folyamatban van. "Törlés" – a Cosmos DB-fiók törlése folyamatban van. "Sikertelen" – a Cosmos DB-fiók létrehozása nem sikerült. "DeletionFailed" – A Cosmos DB-fiók törlése sikertelen volt.
properties.publicNetworkAccess	PublicNetworkAccess		Engedélyezve vannak-e a nyilvános hálózatról érkező kérések
properties.readLocations	Location[]		A Cosmos DB-fiókhoz engedélyezett olvasási helyeket tartalmazó tömb.
properties.restoreParameters	RestoreParameters		A visszaállítással kapcsolatos információkat jelző paraméterek.
properties.virtualNetworkRules	VirtualNetworkRule[]		A Cosmos DB-fiókhoz konfigurált Virtual Network ACL-szabályok listája.
properties.writeLocations	Location[]		A Cosmos DB-fiók írási helyét tartalmazó tömb.
systemData	systemData		Az erőforráshoz kapcsolódó rendszer metaadatai.
tags	object		A címkék az erőforrást leíró kulcs-érték párok listája. Ezek a címkék használhatók az erőforrás megtekintéséhez és csoportosításához (erőforráscsoportok között). Egy erőforráshoz legfeljebb 15 címke adható meg. Minden címkének 128 karakternél nem hosszabb és 256 karakternél nem nagyobb értékű kulcsnak kell lennie. Egy sablontípus alapértelmezett felülete például a "defaultExperience": "Cassandra" értékre van állítva. Az aktuális "defaultExperience" értékek közé tartozik a "Table", a "Graph", a "DocumentDB" és a "MongoDB" is.
type	string		Az Azure-erőforrás típusa.

DatabaseAccountKeysMetadata

Az adott Cosmos DB-adatbázisfiók minden hozzáférési kulcsához kapcsolódó metaadatok.

Name	Típus	Description
primaryMasterKey	AccountKeyMetadata	Az adott Cosmos DB-adatbázisfiók elsődleges Read-Write kulcsához kapcsolódó metaadatok.
primaryReadonlyMasterKey	AccountKeyMetadata	Az adott Cosmos DB-adatbázisfiók elsődleges Read-Only kulcsához kapcsolódó metaadatok.
secondaryMasterKey	AccountKeyMetadata	Az adott Cosmos DB-adatbázisfiók másodlagos Read-Write kulcsához kapcsolódó metaadatok.
secondaryReadonlyMasterKey	AccountKeyMetadata	Az adott Cosmos DB-adatbázisfiók másodlagos Read-Only kulcsához kapcsolódó metaadatok.

DatabaseAccountKind

Az adatbázisfiók típusát jelzi. Ez csak adatbázisfiók létrehozásakor állítható be.

Name	Típus	Description
GlobalDocumentDB	string
MongoDB	string
Parse	string

DatabaseAccountOfferType

A Cosmos DB-adatbázisfiók ajánlattípusa.

Name	Típus	Description
Standard	string

DatabaseAccountsListResult

A List művelet válasza, amely tartalmazza az adatbázisfiókokat és azok tulajdonságait.

Name	Típus	Description
value	DatabaseAccountGetResults[]	Az adatbázisfiókok és tulajdonságaik listája.

DatabaseRestoreResource

Adott visszaállítandó adatbázisok.

Name	Típus	Description
collectionNames	string[]	A visszaállításra rendelkezésre álló gyűjtemények neve.
databaseName	string	A visszaállítható adatbázis neve.

DefaultConsistencyLevel

A Cosmos DB-fiók alapértelmezett konzisztenciaszintje és konfigurációs beállításai.

Name	Típus	Description
BoundedStaleness	string
ConsistentPrefix	string
Eventual	string
Session	string
Strong	string

FailoverPolicy

Az adatbázisfiók adott régiójára vonatkozó feladatátvételi szabályzat.

Name	Típus	Description
failoverPriority	integer	A régió feladatátvételi prioritása. A 0 feladatátvételi prioritás írási régiót jelöl. A feladatátvételi prioritás maximális értéke = (régiók teljes száma – 1). A feladatátvételi prioritás értékeinek egyedinek kell lenniük minden olyan régióban, amelyben az adatbázisfiók létezik.
id	string	Annak a régiónak az egyedi azonosítója, ahová az adatbázisfiók replikál. Példa: <accountName-locationName>><.
locationName	string	Annak a régiónak a neve, amelyben az adatbázisfiók létezik.

GremlinDatabaseRestoreResource

Adott gremlin-adatbázisok visszaállítása.

Name	Típus	Description
databaseName	string	A visszaállítható Gremlin-adatbázis neve.
graphNames	string[]	A visszaállításhoz elérhető gráfok neve.

IpAddressOrRange

IpAddressOrRange objektum

Name	Típus	Description
ipAddressOrRange	string	Egyetlen IPv4-cím vagy egyetlen IPv4-címtartomány CIDR formátumban. A megadott IP-címeknek jól formázottnak kell lenniük, és nem szerepelhetnek a következő tartományok egyikében: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, mivel ezek az IP-címszűrővel nem érvényesíthetők. Példa érvényes bemenetekre: "23.40.210.245" vagy "23.40.210.0/8".

Location

Egy régió, amelyben az Azure Cosmos DB-adatbázisfiók üzembe lett helyezve.

Name	Típus	Description
documentEndpoint	string	Az adott régió kapcsolati végpontja. Példa: https://< accountName-locationName.documents.azure.com:443/><>
failoverPriority	integer	A régió feladatátvételi prioritása. A 0 feladatátvételi prioritás írási régiót jelöl. A feladatátvételi prioritás maximális értéke = (régiók teljes száma – 1). A feladatátvételi prioritás értékeinek egyedinek kell lenniük minden olyan régióban, amelyben az adatbázisfiók létezik.
id	string	Az adatbázisfiókon belüli régió egyedi azonosítója. Példa: <accountName-locationName>><.
isZoneRedundant	boolean	Jelölő annak jelzésére, hogy ez a régió rendelkezésre állási terület-e vagy sem
locationName	string	A régió neve.
provisioningState	string	A Cosmos DB-fiók állapota a művelet meghívásának időpontjában. Az állapot az alábbiak egyike lehet. "Létrehozás" – a Cosmos DB-fiók létrehozása folyamatban van. Ha egy fiók Létrehozás állapotban van, a rendszer csak a Cosmos DB-fiók létrehozása művelet bemeneteként megadott tulajdonságokat adja vissza. "Sikeres" – a Cosmos DB-fiók használatban van. "Frissítés" – a Cosmos DB-fiók frissítése folyamatban van. "Törlés" – a Cosmos DB-fiók törlése folyamatban van. "Sikertelen" – a Cosmos DB-fiók létrehozása nem sikerült. "DeletionFailed" – A Cosmos DB-fiók törlése sikertelen volt.

ManagedServiceIdentity

Az erőforrás identitása.

Name	Típus	Description
principalId	string	A rendszer által hozzárendelt identitás egyszerű azonosítója. Ez a tulajdonság csak a rendszer által hozzárendelt identitáshoz lesz megadva.
tenantId	string	A rendszer által hozzárendelt identitás bérlőazonosítója. Ez a tulajdonság csak a rendszer által hozzárendelt identitáshoz lesz megadva.
type	ResourceIdentityType	Az erőforráshoz használt identitás típusa. A "SystemAssigned,UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból.
userAssignedIdentities	UserAssignedIdentities	Az erőforráshoz társított felhasználói identitások listája. A felhasználói identitás szótárkulcs-hivatkozásai ARM-erőforrásazonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

MinimalTlsVersion

A minimálisan engedélyezett TLS-verziót jelzi. Az alapértelmezett érték a Tls 1.2. A Cassandra és a Mongo API-k csak a Tls 1.2-vel működnek.

Name	Típus	Description
Tls	string
Tls11	string
Tls12	string

NetworkAclBypass

Azt jelzi, hogy mely szolgáltatások kerülhetik meg a tűzfalellenőrzéseket.

Name	Típus	Description
AzureServices	string
None	string

PeriodicModeBackupPolicy

Az időszakos módú biztonsági mentési szabályzatot képviselő objektum.

Name	Típus	Description
migrationState	BackupPolicyMigrationState	A biztonsági mentési szabályzatok közötti migrálás állapotát jelölő objektum.
periodicModeProperties	PeriodicModeProperties	A rendszeres módú biztonsági mentés konfigurációs értékei
type	string: Periodic	A biztonsági mentések módját ismerteti.

PeriodicModeProperties

A rendszeres módú biztonsági mentés konfigurációs értékei

Name	Típus	Description
backupIntervalInMinutes	integer	Egy egész szám, amely két biztonsági mentés közötti percekben megadott időközt jelöli
backupRetentionIntervalInHours	integer	Egy egész szám, amely az egyes biztonsági másolatok megőrzésének idejét (órákban) jelöli
backupStorageRedundancy	BackupStorageRedundancy	Enumerálás a biztonsági mentési hely típusának jelzéséhez

PrivateEndpointConnection

Privát végponti kapcsolat

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.groupId	string	A privát végpont csoportazonosítója.
properties.privateEndpoint	PrivateEndpointProperty	Privát végpont, amelyhez a kapcsolat tartozik.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	A privát végponti kapcsolat kapcsolati állapota.
properties.provisioningState	string	A privát végpont kiépítési állapota.
type	string	Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

Privát végpont, amelyhez a kapcsolat tartozik.

Name	Típus	Description
id	string	A privát végpont erőforrás-azonosítója.

PrivateLinkServiceConnectionStateProperty

A privát végponti kapcsolat kapcsolati állapota.

Name	Típus	Description
actionsRequired	string	Minden olyan művelet, amely az alapszintű munkafolyamaton túl szükséges (jóváhagyás/elutasítás/leválasztás)
description	string	A private link szolgáltatás kapcsolatának leírása.
status	string	A private link szolgáltatás kapcsolati állapota.

PublicNetworkAccess

Engedélyezve vannak-e a nyilvános hálózatról érkező kérések

Name	Típus	Description
Disabled	string
Enabled	string
SecuredByPerimeter	string

ResourceIdentityType

Az erőforráshoz használt identitás típusa. A "SystemAssigned,UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból.

Name	Típus	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

RestoreMode

A visszaállítás módját ismerteti.

Name	Típus	Description
PointInTime	string

RestoreParameters

A visszaállítással kapcsolatos információkat jelző paraméterek.

Name	Típus	Description
databasesToRestore	DatabaseRestoreResource[]	A visszaállításhoz elérhető adatbázisok listája.
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	A visszaállítható gremlin-adatbázisok listája.
restoreMode	RestoreMode	A visszaállítás módját ismerteti.
restoreSource	string	Annak a visszaállítható adatbázisfióknak az azonosítója, amelyből a visszaállítást el kell indítani. Például: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	A fiók visszaállításának ideje (ISO-8601 formátum).
tablesToRestore	string[]	A visszaállításhoz elérhető táblák listája.

ServerVersion

Egy MongoDB-fiók ServerVersion függvényét ismerteti.

Name	Típus	Description
3.2	string
3.6	string
4.0	string
4.2	string

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást utoljára módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

UserAssignedIdentities

Az erőforráshoz társított felhasználói identitások listája. A felhasználói identitás szótárkulcs-hivatkozásai ARM-erőforrásazonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Name	Típus	Description

VirtualNetworkRule

ACL-szabályobjektum Virtual Network

Name	Típus	Description
id	string	Egy alhálózat erőforrás-azonosítója, például: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignoreMissingVNetServiceEndpoint	boolean	Hozzon létre tűzfalszabályt, mielőtt a virtuális hálózatban engedélyezve van a virtuális hálózati szolgáltatásvégpont.

Database Accounts - List By Resource Group

URI-paraméterek

Válaszok

Biztonság

azure_auth

Scopes

Példák

CosmosDBDatabaseAccountListByResourceGroup

Sample Request

Sample Response

Definíciók

AccountKeyMetadata

AnalyticalStorageConfiguration

AnalyticalStorageSchemaType

ApiProperties

BackupPolicyMigrationState

BackupPolicyMigrationStatus

BackupPolicyType

BackupStorageRedundancy

Capability

Capacity

ConnectorOffer

ConsistencyPolicy

ContinuousModeBackupPolicy

ContinuousModeProperties

ContinuousTier

CorsPolicy

createdByType

CreateMode

DatabaseAccountGetResults

DatabaseAccountKeysMetadata

DatabaseAccountKind

DatabaseAccountOfferType

DatabaseAccountsListResult

DatabaseRestoreResource

DefaultConsistencyLevel

FailoverPolicy

GremlinDatabaseRestoreResource

IpAddressOrRange

Location

ManagedServiceIdentity

MinimalTlsVersion

NetworkAclBypass

PeriodicModeBackupPolicy

PeriodicModeProperties

PrivateEndpointConnection

PrivateEndpointProperty

PrivateLinkServiceConnectionStateProperty

PublicNetworkAccess

ResourceIdentityType

RestoreMode

RestoreParameters

ServerVersion

systemData

UserAssignedIdentities

VirtualNetworkRule

További források