Database Accounts - Create Or Update

Service:

Cosmos DB Resource Provider

API Version:

2023-11-15

Létrehoz vagy frissít egy Azure Cosmos DB-adatbázisfiókot. A "Frissítés" metódust részesíti előnyben, ha frissítéseket hajt végre egy fiókon.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
accountName	path	True	string	Cosmos DB-adatbázisfiók neve. Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*
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ó.

Kérelem törzse

Name	Kötelező	Típus	Description
properties.databaseAccountOfferType	True	DatabaseAccountOfferType	Az adatbázis ajánlattípusa
properties.locations	True	Location[]	A Cosmos DB-fiókhoz engedélyezett georeplicációs helyeket tartalmazó tömb.
identity		ManagedServiceIdentity	Az erőforrás identitása.
kind		DatabaseAccountKind	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.
properties.analyticalStorageConfiguration		AnalyticalStorageConfiguration	Elemzési tárolóspecifikus tulajdonságok.
properties.apiProperties		ApiProperties	API-specifikus tulajdonságok. Jelenleg csak a MongoDB API-hoz támogatott.
properties.backupPolicy		BackupPolicy: PeriodicModeBackupPolicy ContinuousModeBackupPolicy	A fiók biztonsági mentésének szabályzatát képviselő objektum.
properties.capabilities		Capability[]	A cosmos DB-képességek listája a fiókhoz
properties.capacity		Capacity	Az objektum, amely a fiók kapacitás-kényszerítéséhez kapcsolódó összes tulajdonságot jelöli.
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-fiók konzisztenciaszabályzata.
properties.cors		CorsPolicy[]	A Cosmos DB-adatbázisfiók CORS-szabályzata.
properties.createMode		CreateMode	Szám a fióklétrehozás módjának jelzésére.
properties.customerManagedKeyStatus		string	A fiók ügyfél által kezelt kulcs funkciójának állapotát jelzi. Hibák esetén a tulajdonság hibaelhárítási útmutatást nyújt.
properties.defaultIdentity		string	Az alapértelmezett identitás a kulcstartó eléréséhez, amelyet olyan funkciókban használnak, mint az ügyfél által felügyelt kulcsok. Az alapértelmezett identitást a felhasználóknak explicit módon kell beállítaniuk. Ez lehet "FirstPartyIdentity", "SystemAssignedIdentity" és egyebek.
properties.disableKeyBasedMetadataWriteAccess		boolean	Metaadat-erőforrások (adatbázisok, tárolók, átviteli sebesség) írási műveleteinek letiltása fiókkulcsokkal
properties.disableLocalAuth		boolean	A helyi hitelesítés letiltása és annak biztosítása, hogy csak az MSI és az AAD használható kizárólag hitelesítésre.
properties.enableAnalyticalStorage		boolean	A tárolóelemzés engedélyezésének engedélyezését jelző jelző.
properties.enableAutomaticFailover		boolean	Engedélyezi az írási régió automatikus feladatátvételét abban a ritka esetben, amikor a régió kimaradá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	Jelölő a kapacitáskitörés 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 partícióegyesítési funkció engedélyezését/letiltását jelző jelző a fiókban
properties.ipRules		IpAddressOrRange[]	IpRules listája.
properties.isVirtualNetworkFilterEnabled		boolean	Jelölő, amely jelzi, hogy engedélyezni vagy letiltani Virtual Network ACL-szabályokat.
properties.keyVaultKeyUri		string	A kulcstartó URI-ja
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.publicNetworkAccess		PublicNetworkAccess	A nyilvános hálózatról érkező kérések engedélyezése
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.
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 nagyobb és 256 karakternél nem nagyobb értékű kulcsnak kell lennie. Egy sablontípus alapértelmezett felülete például "defaultExperience": "Cassandra". A jelenlegi "defaultExperience" értékek közé tartozik a "Table", a "Graph", a "DocumentDB" és a "MongoDB".

Válaszok

Name	Típus	Description
200 OK	DatabaseAccountGetResults	Az adatbázisfiók létrehozási vagy frissítési művelete aszinkron módon fejeződik be.

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

CosmosDBDatabaseAccountCreateMax

CosmosDBDatabaseAccountCreateMin

CosmosDBRestoreDatabaseAccountCreateUpdate.json

CosmosDBDatabaseAccountCreateMax

Sample Request

HTTP

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

{
  "location": "westus",
  "tags": {},
  "kind": "MongoDB",
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
    }
  },
  "properties": {
    "databaseAccountOfferType": "Standard",
    "ipRules": [
      {
        "ipAddressOrRange": "23.43.230.120"
      },
      {
        "ipAddressOrRange": "110.12.240.0/12"
      }
    ],
    "isVirtualNetworkFilterEnabled": true,
    "virtualNetworkRules": [
      {
        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        "ignoreMissingVNetServiceEndpoint": false
      }
    ],
    "publicNetworkAccess": "Enabled",
    "locations": [
      {
        "failoverPriority": 0,
        "locationName": "southcentralus",
        "isZoneRedundant": false
      },
      {
        "failoverPriority": 1,
        "locationName": "eastus",
        "isZoneRedundant": false
      }
    ],
    "consistencyPolicy": {
      "defaultConsistencyLevel": "BoundedStaleness",
      "maxIntervalInSeconds": 10,
      "maxStalenessPrefix": 200
    },
    "keyVaultKeyUri": "https://myKeyVault.vault.azure.net",
    "defaultIdentity": "FirstPartyIdentity",
    "enableFreeTier": false,
    "apiProperties": {
      "serverVersion": "3.2"
    },
    "enableAnalyticalStorage": true,
    "enableBurstCapacity": true,
    "analyticalStorageConfiguration": {
      "schemaType": "WellDefined"
    },
    "createMode": "Default",
    "backupPolicy": {
      "type": "Periodic",
      "periodicModeProperties": {
        "backupIntervalInMinutes": 240,
        "backupRetentionIntervalInHours": 8,
        "backupStorageRedundancy": "Geo"
      }
    },
    "cors": [
      {
        "allowedOrigins": "https://test"
      }
    ],
    "networkAclBypass": "AzureServices",
    "networkAclBypassResourceIds": [
      "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"
    ],
    "capacity": {
      "totalThroughputLimit": 2000
    },
    "minimalTlsVersion": "Tls12"
  }
}

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_create_max.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.begin_create_or_update(
        resource_group_name="rg1",
        account_name="ddb1",
        create_update_parameters={
            "identity": {
                "type": "SystemAssigned,UserAssigned",
                "userAssignedIdentities": {
                    "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
                },
            },
            "kind": "MongoDB",
            "location": "westus",
            "properties": {
                "analyticalStorageConfiguration": {"schemaType": "WellDefined"},
                "apiProperties": {"serverVersion": "3.2"},
                "backupPolicy": {
                    "periodicModeProperties": {
                        "backupIntervalInMinutes": 240,
                        "backupRetentionIntervalInHours": 8,
                        "backupStorageRedundancy": "Geo",
                    },
                    "type": "Periodic",
                },
                "capacity": {"totalThroughputLimit": 2000},
                "consistencyPolicy": {
                    "defaultConsistencyLevel": "BoundedStaleness",
                    "maxIntervalInSeconds": 10,
                    "maxStalenessPrefix": 200,
                },
                "cors": [{"allowedOrigins": "https://test"}],
                "createMode": "Default",
                "databaseAccountOfferType": "Standard",
                "defaultIdentity": "FirstPartyIdentity",
                "enableAnalyticalStorage": True,
                "enableBurstCapacity": True,
                "enableFreeTier": False,
                "ipRules": [{"ipAddressOrRange": "23.43.230.120"}, {"ipAddressOrRange": "110.12.240.0/12"}],
                "isVirtualNetworkFilterEnabled": True,
                "keyVaultKeyUri": "https://myKeyVault.vault.azure.net",
                "locations": [
                    {"failoverPriority": 0, "isZoneRedundant": False, "locationName": "southcentralus"},
                    {"failoverPriority": 1, "isZoneRedundant": False, "locationName": "eastus"},
                ],
                "minimalTlsVersion": "Tls12",
                "networkAclBypass": "AzureServices",
                "networkAclBypassResourceIds": [
                    "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"
                ],
                "publicNetworkAccess": "Enabled",
                "virtualNetworkRules": [
                    {
                        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
                        "ignoreMissingVNetServiceEndpoint": False,
                    }
                ],
            },
            "tags": {},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountCreateMax.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/azcore/to"
	"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/CosmosDBDatabaseAccountCreateMax.json
func ExampleDatabaseAccountsClient_BeginCreateOrUpdate_cosmosDbDatabaseAccountCreateMax() {
	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)
	}
	poller, err := clientFactory.NewDatabaseAccountsClient().BeginCreateOrUpdate(ctx, "rg1", "ddb1", armcosmos.DatabaseAccountCreateUpdateParameters{
		Location: to.Ptr("westus"),
		Tags:     map[string]*string{},
		Identity: &armcosmos.ManagedServiceIdentity{
			Type: to.Ptr(armcosmos.ResourceIdentityTypeSystemAssignedUserAssigned),
			UserAssignedIdentities: map[string]*armcosmos.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
				"/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
			},
		},
		Kind: to.Ptr(armcosmos.DatabaseAccountKindMongoDB),
		Properties: &armcosmos.DatabaseAccountCreateUpdateProperties{
			AnalyticalStorageConfiguration: &armcosmos.AnalyticalStorageConfiguration{
				SchemaType: to.Ptr(armcosmos.AnalyticalStorageSchemaTypeWellDefined),
			},
			APIProperties: &armcosmos.APIProperties{
				ServerVersion: to.Ptr(armcosmos.ServerVersionThree2),
			},
			BackupPolicy: &armcosmos.PeriodicModeBackupPolicy{
				Type: to.Ptr(armcosmos.BackupPolicyTypePeriodic),
				PeriodicModeProperties: &armcosmos.PeriodicModeProperties{
					BackupIntervalInMinutes:        to.Ptr[int32](240),
					BackupRetentionIntervalInHours: to.Ptr[int32](8),
					BackupStorageRedundancy:        to.Ptr(armcosmos.BackupStorageRedundancyGeo),
				},
			},
			Capacity: &armcosmos.Capacity{
				TotalThroughputLimit: to.Ptr[int32](2000),
			},
			ConsistencyPolicy: &armcosmos.ConsistencyPolicy{
				DefaultConsistencyLevel: to.Ptr(armcosmos.DefaultConsistencyLevelBoundedStaleness),
				MaxIntervalInSeconds:    to.Ptr[int32](10),
				MaxStalenessPrefix:      to.Ptr[int64](200),
			},
			Cors: []*armcosmos.CorsPolicy{
				{
					AllowedOrigins: to.Ptr("https://test"),
				}},
			CreateMode:               to.Ptr(armcosmos.CreateModeDefault),
			DatabaseAccountOfferType: to.Ptr("Standard"),
			DefaultIdentity:          to.Ptr("FirstPartyIdentity"),
			EnableAnalyticalStorage:  to.Ptr(true),
			EnableBurstCapacity:      to.Ptr(true),
			EnableFreeTier:           to.Ptr(false),
			IPRules: []*armcosmos.IPAddressOrRange{
				{
					IPAddressOrRange: to.Ptr("23.43.230.120"),
				},
				{
					IPAddressOrRange: to.Ptr("110.12.240.0/12"),
				}},
			IsVirtualNetworkFilterEnabled: to.Ptr(true),
			KeyVaultKeyURI:                to.Ptr("https://myKeyVault.vault.azure.net"),
			Locations: []*armcosmos.Location{
				{
					FailoverPriority: to.Ptr[int32](0),
					IsZoneRedundant:  to.Ptr(false),
					LocationName:     to.Ptr("southcentralus"),
				},
				{
					FailoverPriority: to.Ptr[int32](1),
					IsZoneRedundant:  to.Ptr(false),
					LocationName:     to.Ptr("eastus"),
				}},
			MinimalTLSVersion: to.Ptr(armcosmos.MinimalTLSVersionTls12),
			NetworkACLBypass:  to.Ptr(armcosmos.NetworkACLBypassAzureServices),
			NetworkACLBypassResourceIDs: []*string{
				to.Ptr("/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName")},
			PublicNetworkAccess: to.Ptr(armcosmos.PublicNetworkAccessEnabled),
			VirtualNetworkRules: []*armcosmos.VirtualNetworkRule{
				{
					ID:                               to.Ptr("/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1"),
					IgnoreMissingVNetServiceEndpoint: to.Ptr(false),
				}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.DatabaseAccountKindMongoDB),
	// 	Properties: &armcosmos.DatabaseAccountGetProperties{
	// 		AnalyticalStorageConfiguration: &armcosmos.AnalyticalStorageConfiguration{
	// 			SchemaType: to.Ptr(armcosmos.AnalyticalStorageSchemaTypeWellDefined),
	// 		},
	// 		APIProperties: &armcosmos.APIProperties{
	// 			ServerVersion: to.Ptr(armcosmos.ServerVersionThree2),
	// 		},
	// 		BackupPolicy: &armcosmos.PeriodicModeBackupPolicy{
	// 			Type: to.Ptr(armcosmos.BackupPolicyTypePeriodic),
	// 			PeriodicModeProperties: &armcosmos.PeriodicModeProperties{
	// 				BackupIntervalInMinutes: to.Ptr[int32](240),
	// 				BackupRetentionIntervalInHours: to.Ptr[int32](8),
	// 				BackupStorageRedundancy: to.Ptr(armcosmos.BackupStorageRedundancyGeo),
	// 			},
	// 		},
	// 		Capacity: &armcosmos.Capacity{
	// 			TotalThroughputLimit: to.Ptr[int32](2000),
	// 		},
	// 		ConsistencyPolicy: &armcosmos.ConsistencyPolicy{
	// 			DefaultConsistencyLevel: to.Ptr(armcosmos.DefaultConsistencyLevelBoundedStaleness),
	// 			MaxIntervalInSeconds: to.Ptr[int32](10),
	// 			MaxStalenessPrefix: to.Ptr[int64](200),
	// 		},
	// 		Cors: []*armcosmos.CorsPolicy{
	// 			{
	// 				AllowedOrigins: to.Ptr("https://test"),
	// 		}},
	// 		CreateMode: to.Ptr(armcosmos.CreateModeDefault),
	// 		DatabaseAccountOfferType: to.Ptr("Standard"),
	// 		DefaultIdentity: to.Ptr("FirstPartyIdentity"),
	// 		DisableKeyBasedMetadataWriteAccess: to.Ptr(false),
	// 		EnableAnalyticalStorage: to.Ptr(true),
	// 		EnableBurstCapacity: to.Ptr(true),
	// 		EnableFreeTier: to.Ptr(false),
	// 		FailoverPolicies: []*armcosmos.FailoverPolicy{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-southcentralus"),
	// 				LocationName: to.Ptr("South Central US"),
	// 			},
	// 			{
	// 				FailoverPriority: to.Ptr[int32](1),
	// 				ID: to.Ptr("ddb1-eastus"),
	// 				LocationName: to.Ptr("East US"),
	// 		}},
	// 		InstanceID: to.Ptr("d9b26648-2f53-4541-b3d8-3044f4f9810d"),
	// 		IPRules: []*armcosmos.IPAddressOrRange{
	// 			{
	// 				IPAddressOrRange: to.Ptr("23.43.230.120"),
	// 			},
	// 			{
	// 				IPAddressOrRange: to.Ptr("110.12.240.0/12"),
	// 		}},
	// 		IsVirtualNetworkFilterEnabled: to.Ptr(true),
	// 		KeyVaultKeyURI: to.Ptr("https://myKeyVault.vault.azure.net"),
	// 		KeysMetadata: &armcosmos.DatabaseAccountKeysMetadata{
	// 			PrimaryMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 			},
	// 			PrimaryReadonlyMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 			},
	// 			SecondaryMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 			},
	// 			SecondaryReadonlyMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 			},
	// 		},
	// 		Locations: []*armcosmos.Location{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-southcentralus"),
	// 				IsZoneRedundant: to.Ptr(false),
	// 				LocationName: to.Ptr("South Central US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 			},
	// 			{
	// 				FailoverPriority: to.Ptr[int32](1),
	// 				ID: to.Ptr("ddb1-eastus"),
	// 				IsZoneRedundant: to.Ptr(false),
	// 				LocationName: to.Ptr("East US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 		}},
	// 		MinimalTLSVersion: to.Ptr(armcosmos.MinimalTLSVersionTls12),
	// 		NetworkACLBypass: to.Ptr(armcosmos.NetworkACLBypassAzureServices),
	// 		NetworkACLBypassResourceIDs: []*string{
	// 			to.Ptr("/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName")},
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			PublicNetworkAccess: to.Ptr(armcosmos.PublicNetworkAccessEnabled),
	// 			ReadLocations: []*armcosmos.Location{
	// 				{
	// 					FailoverPriority: to.Ptr[int32](0),
	// 					ID: to.Ptr("ddb1-southcentralus"),
	// 					IsZoneRedundant: to.Ptr(false),
	// 					LocationName: to.Ptr("South Central US"),
	// 					ProvisioningState: to.Ptr("Succeeded"),
	// 				},
	// 				{
	// 					FailoverPriority: to.Ptr[int32](1),
	// 					ID: to.Ptr("ddb1-eastus"),
	// 					IsZoneRedundant: to.Ptr(false),
	// 					LocationName: to.Ptr("East US"),
	// 					ProvisioningState: to.Ptr("Succeeded"),
	// 			}},
	// 			VirtualNetworkRules: []*armcosmos.VirtualNetworkRule{
	// 				{
	// 					ID: to.Ptr("/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1"),
	// 			}},
	// 			WriteLocations: []*armcosmos.Location{
	// 				{
	// 					FailoverPriority: to.Ptr[int32](0),
	// 					ID: to.Ptr("ddb1-southcentralus"),
	// 					IsZoneRedundant: to.Ptr(false),
	// 					LocationName: to.Ptr("South Central US"),
	// 					ProvisioningState: to.Ptr("Succeeded"),
	// 			}},
	// 		},
	// 		SystemData: &armcosmos.SystemData{
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 		},
	// 	}
}

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 Creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account.
 *
 * @summary Creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountCreateMax.json
 */
async function cosmosDbDatabaseAccountCreateMax() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const createUpdateParameters = {
    analyticalStorageConfiguration: { schemaType: "WellDefined" },
    apiProperties: { serverVersion: "3.2" },
    backupPolicy: {
      type: "Periodic",
      periodicModeProperties: {
        backupIntervalInMinutes: 240,
        backupRetentionIntervalInHours: 8,
        backupStorageRedundancy: "Geo",
      },
    },
    capacity: { totalThroughputLimit: 2000 },
    consistencyPolicy: {
      defaultConsistencyLevel: "BoundedStaleness",
      maxIntervalInSeconds: 10,
      maxStalenessPrefix: 200,
    },
    cors: [{ allowedOrigins: "https://test" }],
    createMode: "Default",
    databaseAccountOfferType: "Standard",
    defaultIdentity: "FirstPartyIdentity",
    enableAnalyticalStorage: true,
    enableBurstCapacity: true,
    enableFreeTier: false,
    identity: {
      type: "SystemAssigned,UserAssigned",
      userAssignedIdentities: {
        "/subscriptions/fa5fc227A624475eB696Cdd604c735bc/resourceGroups/eu2cgroup/providers/MicrosoftManagedIdentity/userAssignedIdentities/id1":
          {},
      },
    },
    ipRules: [{ ipAddressOrRange: "23.43.230.120" }, { ipAddressOrRange: "110.12.240.0/12" }],
    isVirtualNetworkFilterEnabled: true,
    keyVaultKeyUri: "https://myKeyVault.vault.azure.net",
    kind: "MongoDB",
    location: "westus",
    locations: [
      {
        failoverPriority: 0,
        isZoneRedundant: false,
        locationName: "southcentralus",
      },
      { failoverPriority: 1, isZoneRedundant: false, locationName: "eastus" },
    ],
    minimalTlsVersion: "Tls12",
    networkAclBypass: "AzureServices",
    networkAclBypassResourceIds: [
      "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName",
    ],
    publicNetworkAccess: "Enabled",
    tags: {},
    virtualNetworkRules: [
      {
        id: "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        ignoreMissingVNetServiceEndpoint: false,
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.databaseAccounts.beginCreateOrUpdateAndWait(
    resourceGroupName,
    accountName,
    createUpdateParameters,
  );
  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": "MongoDB",
  "tags": {},
  "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"
      }
    }
  },
  "properties": {
    "provisioningState": "Initializing",
    "isVirtualNetworkFilterEnabled": true,
    "databaseAccountOfferType": "Standard",
    "disableKeyBasedMetadataWriteAccess": false,
    "consistencyPolicy": {
      "defaultConsistencyLevel": "BoundedStaleness",
      "maxIntervalInSeconds": 10,
      "maxStalenessPrefix": 200
    },
    "writeLocations": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "provisioningState": "Initializing",
        "failoverPriority": 0,
        "isZoneRedundant": false
      }
    ],
    "readLocations": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "provisioningState": "Initializing",
        "failoverPriority": 0,
        "isZoneRedundant": false
      },
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "provisioningState": "Initializing",
        "failoverPriority": 1,
        "isZoneRedundant": false
      }
    ],
    "locations": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "provisioningState": "Initializing",
        "failoverPriority": 0,
        "isZoneRedundant": false
      },
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "provisioningState": "Initializing",
        "failoverPriority": 1,
        "isZoneRedundant": false
      }
    ],
    "failoverPolicies": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "failoverPriority": 0
      },
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "failoverPriority": 1
      }
    ],
    "virtualNetworkRules": [
      {
        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1"
      }
    ],
    "publicNetworkAccess": "Enabled",
    "keyVaultKeyUri": "https://myKeyVault.vault.azure.net",
    "defaultIdentity": "FirstPartyIdentity",
    "enableFreeTier": false,
    "ipRules": [
      {
        "ipAddressOrRange": "23.43.230.120"
      },
      {
        "ipAddressOrRange": "110.12.240.0/12"
      }
    ],
    "apiProperties": {
      "serverVersion": "3.2"
    },
    "enableAnalyticalStorage": true,
    "enableBurstCapacity": true,
    "analyticalStorageConfiguration": {
      "schemaType": "WellDefined"
    },
    "createMode": "Default",
    "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d",
    "backupPolicy": {
      "type": "Periodic",
      "periodicModeProperties": {
        "backupIntervalInMinutes": 240,
        "backupRetentionIntervalInHours": 8,
        "backupStorageRedundancy": "Geo"
      }
    },
    "cors": [
      {
        "allowedOrigins": "https://test"
      }
    ],
    "networkAclBypass": "AzureServices",
    "networkAclBypassResourceIds": [
      "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"
    ],
    "capacity": {
      "totalThroughputLimit": 2000
    },
    "keysMetadata": {
      "primaryMasterKey": {
        "generationTime": "2021-03-12T22:05:09Z"
      },
      "secondaryMasterKey": {
        "generationTime": "2021-03-12T22:05:09Z"
      },
      "primaryReadonlyMasterKey": {
        "generationTime": "2021-03-12T22:05:09Z"
      },
      "secondaryReadonlyMasterKey": {
        "generationTime": "2021-03-12T22:05:09Z"
      }
    },
    "minimalTlsVersion": "Tls12"
  },
  "systemData": {
    "createdAt": "2021-03-12T22:05:09Z"
  }
}

CosmosDBDatabaseAccountCreateMin

Sample Request

HTTP

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

{
  "location": "westus",
  "properties": {
    "databaseAccountOfferType": "Standard",
    "createMode": "Default",
    "locations": [
      {
        "failoverPriority": 0,
        "locationName": "southcentralus",
        "isZoneRedundant": false
      }
    ]
  }
}

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_create_min.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.begin_create_or_update(
        resource_group_name="rg1",
        account_name="ddb1",
        create_update_parameters={
            "location": "westus",
            "properties": {
                "createMode": "Default",
                "databaseAccountOfferType": "Standard",
                "locations": [{"failoverPriority": 0, "isZoneRedundant": False, "locationName": "southcentralus"}],
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountCreateMin.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/azcore/to"
	"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/CosmosDBDatabaseAccountCreateMin.json
func ExampleDatabaseAccountsClient_BeginCreateOrUpdate_cosmosDbDatabaseAccountCreateMin() {
	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)
	}
	poller, err := clientFactory.NewDatabaseAccountsClient().BeginCreateOrUpdate(ctx, "rg1", "ddb1", armcosmos.DatabaseAccountCreateUpdateParameters{
		Location: to.Ptr("westus"),
		Properties: &armcosmos.DatabaseAccountCreateUpdateProperties{
			CreateMode:               to.Ptr(armcosmos.CreateModeDefault),
			DatabaseAccountOfferType: to.Ptr("Standard"),
			Locations: []*armcosmos.Location{
				{
					FailoverPriority: to.Ptr[int32](0),
					IsZoneRedundant:  to.Ptr(false),
					LocationName:     to.Ptr("southcentralus"),
				}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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{
	// 	},
	// 	Kind: to.Ptr(armcosmos.DatabaseAccountKindGlobalDocumentDB),
	// 	Properties: &armcosmos.DatabaseAccountGetProperties{
	// 		APIProperties: &armcosmos.APIProperties{
	// 		},
	// 		BackupPolicy: &armcosmos.PeriodicModeBackupPolicy{
	// 			Type: to.Ptr(armcosmos.BackupPolicyTypePeriodic),
	// 			PeriodicModeProperties: &armcosmos.PeriodicModeProperties{
	// 				BackupIntervalInMinutes: to.Ptr[int32](240),
	// 				BackupRetentionIntervalInHours: to.Ptr[int32](720),
	// 				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"),
	// 		DisableKeyBasedMetadataWriteAccess: to.Ptr(false),
	// 		EnableAnalyticalStorage: to.Ptr(false),
	// 		EnableFreeTier: to.Ptr(false),
	// 		FailoverPolicies: []*armcosmos.FailoverPolicy{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-southcentralus"),
	// 				LocationName: to.Ptr("South Central US"),
	// 		}},
	// 		InstanceID: to.Ptr("d9b26648-2f53-4541-b3d8-3044f4f9810d"),
	// 		IPRules: []*armcosmos.IPAddressOrRange{
	// 		},
	// 		KeysMetadata: &armcosmos.DatabaseAccountKeysMetadata{
	// 			PrimaryMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 			},
	// 			PrimaryReadonlyMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 			},
	// 			SecondaryMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 			},
	// 			SecondaryReadonlyMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 			},
	// 		},
	// 		Locations: []*armcosmos.Location{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-southcentralus"),
	// 				IsZoneRedundant: to.Ptr(false),
	// 				LocationName: to.Ptr("South Central US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 		}},
	// 		MinimalTLSVersion: to.Ptr(armcosmos.MinimalTLSVersionTLS),
	// 		NetworkACLBypass: to.Ptr(armcosmos.NetworkACLBypassNone),
	// 		NetworkACLBypassResourceIDs: []*string{
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ReadLocations: []*armcosmos.Location{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-southcentralus"),
	// 				IsZoneRedundant: to.Ptr(false),
	// 				LocationName: to.Ptr("South Central US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 		}},
	// 		WriteLocations: []*armcosmos.Location{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-southcentralus"),
	// 				IsZoneRedundant: to.Ptr(false),
	// 				LocationName: to.Ptr("South Central US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 		}},
	// 	},
	// 	SystemData: &armcosmos.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 	},
	// }
}

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 Creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account.
 *
 * @summary Creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountCreateMin.json
 */
async function cosmosDbDatabaseAccountCreateMin() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const createUpdateParameters = {
    createMode: "Default",
    databaseAccountOfferType: "Standard",
    location: "westus",
    locations: [
      {
        failoverPriority: 0,
        isZoneRedundant: false,
        locationName: "southcentralus",
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.databaseAccounts.beginCreateOrUpdateAndWait(
    resourceGroupName,
    accountName,
    createUpdateParameters,
  );
  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": "Initializing",
    "ipRules": [],
    "databaseAccountOfferType": "Standard",
    "disableKeyBasedMetadataWriteAccess": false,
    "consistencyPolicy": {
      "defaultConsistencyLevel": "Session",
      "maxIntervalInSeconds": 5,
      "maxStalenessPrefix": 100
    },
    "writeLocations": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "provisioningState": "Initializing",
        "failoverPriority": 0,
        "isZoneRedundant": false
      }
    ],
    "readLocations": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "provisioningState": "Initializing",
        "failoverPriority": 0,
        "isZoneRedundant": false
      }
    ],
    "locations": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "provisioningState": "Initializing",
        "failoverPriority": 0,
        "isZoneRedundant": false
      }
    ],
    "failoverPolicies": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "failoverPriority": 0
      }
    ],
    "cors": [],
    "enableFreeTier": false,
    "apiProperties": {},
    "enableAnalyticalStorage": false,
    "analyticalStorageConfiguration": null,
    "networkAclBypass": "None",
    "networkAclBypassResourceIds": [],
    "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d",
    "createMode": "Default",
    "backupPolicy": {
      "type": "Periodic",
      "periodicModeProperties": {
        "backupIntervalInMinutes": 240,
        "backupRetentionIntervalInHours": 720,
        "backupStorageRedundancy": "Geo"
      }
    },
    "keysMetadata": {
      "primaryMasterKey": {
        "generationTime": "2021-03-12T22:05:09Z"
      },
      "secondaryMasterKey": {
        "generationTime": "2021-03-12T22:05:09Z"
      },
      "primaryReadonlyMasterKey": {
        "generationTime": "2021-03-12T22:05:09Z"
      },
      "secondaryReadonlyMasterKey": {
        "generationTime": "2021-03-12T22:05:09Z"
      }
    },
    "minimalTlsVersion": "Tls"
  },
  "systemData": {
    "createdAt": "2021-03-12T22:05:09Z"
  }
}

CosmosDBRestoreDatabaseAccountCreateUpdate.json

Sample Request

HTTP

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

{
  "location": "westus",
  "tags": {},
  "kind": "GlobalDocumentDB",
  "properties": {
    "databaseAccountOfferType": "Standard",
    "locations": [
      {
        "failoverPriority": 0,
        "locationName": "southcentralus",
        "isZoneRedundant": false
      }
    ],
    "createMode": "Restore",
    "restoreParameters": {
      "restoreMode": "PointInTime",
      "restoreSource": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/1a97b4bb-f6a0-430e-ade1-638d781830cc",
      "restoreTimestampInUtc": "2021-03-11T22:05:09Z",
      "databasesToRestore": [
        {
          "databaseName": "db1",
          "collectionNames": [
            "collection1",
            "collection2"
          ]
        },
        {
          "databaseName": "db2",
          "collectionNames": [
            "collection3",
            "collection4"
          ]
        }
      ]
    },
    "backupPolicy": {
      "type": "Continuous",
      "continuousModeProperties": {
        "tier": "Continuous30Days"
      }
    },
    "consistencyPolicy": {
      "defaultConsistencyLevel": "BoundedStaleness",
      "maxIntervalInSeconds": 10,
      "maxStalenessPrefix": 200
    },
    "keyVaultKeyUri": "https://myKeyVault.vault.azure.net",
    "enableFreeTier": false,
    "apiProperties": {
      "serverVersion": "3.2"
    },
    "enableAnalyticalStorage": true,
    "minimalTlsVersion": "Tls"
  }
}

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_restore_database_account_create_update.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.begin_create_or_update(
        resource_group_name="rg1",
        account_name="ddb1",
        create_update_parameters={
            "kind": "GlobalDocumentDB",
            "location": "westus",
            "properties": {
                "apiProperties": {"serverVersion": "3.2"},
                "backupPolicy": {"continuousModeProperties": {"tier": "Continuous30Days"}, "type": "Continuous"},
                "consistencyPolicy": {
                    "defaultConsistencyLevel": "BoundedStaleness",
                    "maxIntervalInSeconds": 10,
                    "maxStalenessPrefix": 200,
                },
                "createMode": "Restore",
                "databaseAccountOfferType": "Standard",
                "enableAnalyticalStorage": True,
                "enableFreeTier": False,
                "keyVaultKeyUri": "https://myKeyVault.vault.azure.net",
                "locations": [{"failoverPriority": 0, "isZoneRedundant": False, "locationName": "southcentralus"}],
                "minimalTlsVersion": "Tls",
                "restoreParameters": {
                    "databasesToRestore": [
                        {"collectionNames": ["collection1", "collection2"], "databaseName": "db1"},
                        {"collectionNames": ["collection3", "collection4"], "databaseName": "db2"},
                    ],
                    "restoreMode": "PointInTime",
                    "restoreSource": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/1a97b4bb-f6a0-430e-ade1-638d781830cc",
                    "restoreTimestampInUtc": "2021-03-11T22:05:09Z",
                },
            },
            "tags": {},
        },
    ).result()
    print(response)


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

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/CosmosDBRestoreDatabaseAccountCreateUpdate.json
func ExampleDatabaseAccountsClient_BeginCreateOrUpdate_cosmosDbRestoreDatabaseAccountCreateUpdateJson() {
	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)
	}
	poller, err := clientFactory.NewDatabaseAccountsClient().BeginCreateOrUpdate(ctx, "rg1", "ddb1", armcosmos.DatabaseAccountCreateUpdateParameters{
		Location: to.Ptr("westus"),
		Tags:     map[string]*string{},
		Kind:     to.Ptr(armcosmos.DatabaseAccountKindGlobalDocumentDB),
		Properties: &armcosmos.DatabaseAccountCreateUpdateProperties{
			APIProperties: &armcosmos.APIProperties{
				ServerVersion: to.Ptr(armcosmos.ServerVersionThree2),
			},
			BackupPolicy: &armcosmos.ContinuousModeBackupPolicy{
				Type: to.Ptr(armcosmos.BackupPolicyTypeContinuous),
				ContinuousModeProperties: &armcosmos.ContinuousModeProperties{
					Tier: to.Ptr(armcosmos.ContinuousTierContinuous30Days),
				},
			},
			ConsistencyPolicy: &armcosmos.ConsistencyPolicy{
				DefaultConsistencyLevel: to.Ptr(armcosmos.DefaultConsistencyLevelBoundedStaleness),
				MaxIntervalInSeconds:    to.Ptr[int32](10),
				MaxStalenessPrefix:      to.Ptr[int64](200),
			},
			CreateMode:               to.Ptr(armcosmos.CreateModeRestore),
			DatabaseAccountOfferType: to.Ptr("Standard"),
			EnableAnalyticalStorage:  to.Ptr(true),
			EnableFreeTier:           to.Ptr(false),
			KeyVaultKeyURI:           to.Ptr("https://myKeyVault.vault.azure.net"),
			Locations: []*armcosmos.Location{
				{
					FailoverPriority: to.Ptr[int32](0),
					IsZoneRedundant:  to.Ptr(false),
					LocationName:     to.Ptr("southcentralus"),
				}},
			MinimalTLSVersion: to.Ptr(armcosmos.MinimalTLSVersionTLS),
			RestoreParameters: &armcosmos.RestoreParameters{
				RestoreSource:         to.Ptr("/subscriptions/subid/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/1a97b4bb-f6a0-430e-ade1-638d781830cc"),
				RestoreTimestampInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-11T22:05:09.000Z"); return t }()),
				DatabasesToRestore: []*armcosmos.DatabaseRestoreResource{
					{
						CollectionNames: []*string{
							to.Ptr("collection1"),
							to.Ptr("collection2")},
						DatabaseName: to.Ptr("db1"),
					},
					{
						CollectionNames: []*string{
							to.Ptr("collection3"),
							to.Ptr("collection4")},
						DatabaseName: to.Ptr("db2"),
					}},
				RestoreMode: to.Ptr(armcosmos.RestoreModePointInTime),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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{
	// 	},
	// 	Kind: to.Ptr(armcosmos.DatabaseAccountKindGlobalDocumentDB),
	// 	Properties: &armcosmos.DatabaseAccountGetProperties{
	// 		APIProperties: &armcosmos.APIProperties{
	// 		},
	// 		BackupPolicy: &armcosmos.ContinuousModeBackupPolicy{
	// 			Type: to.Ptr(armcosmos.BackupPolicyTypeContinuous),
	// 			ContinuousModeProperties: &armcosmos.ContinuousModeProperties{
	// 				Tier: to.Ptr(armcosmos.ContinuousTierContinuous30Days),
	// 			},
	// 		},
	// 		ConsistencyPolicy: &armcosmos.ConsistencyPolicy{
	// 			DefaultConsistencyLevel: to.Ptr(armcosmos.DefaultConsistencyLevelSession),
	// 			MaxIntervalInSeconds: to.Ptr[int32](5),
	// 			MaxStalenessPrefix: to.Ptr[int64](100),
	// 		},
	// 		CreateMode: to.Ptr(armcosmos.CreateModeRestore),
	// 		DatabaseAccountOfferType: to.Ptr("Standard"),
	// 		DisableKeyBasedMetadataWriteAccess: to.Ptr(false),
	// 		EnableAnalyticalStorage: to.Ptr(false),
	// 		EnableFreeTier: to.Ptr(false),
	// 		FailoverPolicies: []*armcosmos.FailoverPolicy{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-southcentralus"),
	// 				LocationName: to.Ptr("South Central US"),
	// 		}},
	// 		InstanceID: to.Ptr("d9b26648-2f53-4541-b3d8-3044f4f9810d"),
	// 		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{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-southcentralus"),
	// 				IsZoneRedundant: to.Ptr(false),
	// 				LocationName: to.Ptr("South Central US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 		}},
	// 		MinimalTLSVersion: to.Ptr(armcosmos.MinimalTLSVersionTLS),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ReadLocations: []*armcosmos.Location{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-southcentralus"),
	// 				IsZoneRedundant: to.Ptr(false),
	// 				LocationName: to.Ptr("South Central US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 		}},
	// 		WriteLocations: []*armcosmos.Location{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-southcentralus"),
	// 				IsZoneRedundant: to.Ptr(false),
	// 				LocationName: to.Ptr("South Central US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 		}},
	// 	},
	// 	SystemData: &armcosmos.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 	},
	// }
}

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 Creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account.
 *
 * @summary Creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestoreDatabaseAccountCreateUpdate.json
 */
async function cosmosDbRestoreDatabaseAccountCreateUpdateJson() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const createUpdateParameters = {
    apiProperties: { serverVersion: "3.2" },
    backupPolicy: {
      type: "Continuous",
      continuousModeProperties: { tier: "Continuous30Days" },
    },
    consistencyPolicy: {
      defaultConsistencyLevel: "BoundedStaleness",
      maxIntervalInSeconds: 10,
      maxStalenessPrefix: 200,
    },
    createMode: "Restore",
    databaseAccountOfferType: "Standard",
    enableAnalyticalStorage: true,
    enableFreeTier: false,
    keyVaultKeyUri: "https://myKeyVault.vault.azure.net",
    kind: "GlobalDocumentDB",
    location: "westus",
    locations: [
      {
        failoverPriority: 0,
        isZoneRedundant: false,
        locationName: "southcentralus",
      },
    ],
    minimalTlsVersion: "Tls",
    restoreParameters: {
      databasesToRestore: [
        {
          collectionNames: ["collection1", "collection2"],
          databaseName: "db1",
        },
        { collectionNames: ["collection3", "collection4"], databaseName: "db2" },
      ],
      restoreMode: "PointInTime",
      restoreSource:
        "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/1a97b4bb-f6a0-430e-ade1-638d781830cc",
      restoreTimestampInUtc: new Date("2021-03-11T22:05:09Z"),
    },
    tags: {},
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.databaseAccounts.beginCreateOrUpdateAndWait(
    resourceGroupName,
    accountName,
    createUpdateParameters,
  );
  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": "Initializing",
    "ipRules": [],
    "databaseAccountOfferType": "Standard",
    "disableKeyBasedMetadataWriteAccess": false,
    "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d",
    "createMode": "Restore",
    "consistencyPolicy": {
      "defaultConsistencyLevel": "Session",
      "maxIntervalInSeconds": 5,
      "maxStalenessPrefix": 100
    },
    "writeLocations": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "provisioningState": "Initializing",
        "failoverPriority": 0,
        "isZoneRedundant": false
      }
    ],
    "readLocations": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "provisioningState": "Initializing",
        "failoverPriority": 0,
        "isZoneRedundant": false
      }
    ],
    "locations": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "provisioningState": "Initializing",
        "failoverPriority": 0,
        "isZoneRedundant": false
      }
    ],
    "failoverPolicies": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "failoverPriority": 0
      }
    ],
    "backupPolicy": {
      "type": "Continuous",
      "continuousModeProperties": {
        "tier": "Continuous30Days"
      }
    },
    "enableFreeTier": false,
    "apiProperties": {},
    "enableAnalyticalStorage": false,
    "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"
  },
  "systemData": {
    "createdAt": "2021-03-12T22:05:09Z"
  }
}

Definíciók

Name	Description
AccountKeyMetadata	Az adott adatbázisfiók hozzáférési kulcsához kapcsolódó metaadatok.
AnalyticalStorageConfiguration	Elemzési tárolóspecifikus tulajdonságok.
AnalyticalStorageSchemaType	Az elemzési tárolás sémáinak típusait ismerteti.
ApiProperties
BackupPolicyMigrationState	A biztonsági mentési szabályzatok közötti migrálás állapotát képviselő objektum.
BackupPolicyMigrationStatus	A biztonsági mentési szabályzattípusok közötti migrálás állapotát ismerteti.
BackupPolicyType	A biztonsági mentések módját ismerteti.
BackupStorageRedundancy	A biztonsági mentési tár redundanciának típusának jelzésére szolgáló szám.
Capability	Cosmos DB képességobjektum
Capacity	Az objektum, amely a fiók kapacitás-kényszerítéséhez kapcsolódó összes tulajdonságot jelöli.
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	Szám 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	Szám a fióklétrehozás módjának jelzésére.
DatabaseAccountCreateUpdateParameters	A Cosmos DB-adatbázisfiókok létrehozásához és frissítéséhez használandó paraméterek.
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.
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	Egy 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 van 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égpontkapcsolat
PrivateEndpointProperty	Privát végpont, amelyhez a kapcsolat tartozik.
PrivateLinkServiceConnectionStateProperty	A privát végpontkapcsolat kapcsolati állapota.
PublicNetworkAccess	A nyilvános hálózatról érkező kérések engedélyezése
ResourceIdentityType	Az erőforráshoz használt identitás típusa. A "SystemAssigned,UserAssigned" típus magában foglal egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is. 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-já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árának kulcshivatkozásai a következő űrlapon található ARM-erőforrás-azonosítók: "/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 UTC-ben történő létrehozási ideje 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árolóspecifikus tulajdonságok.

Name	Típus	Description
schemaType	AnalyticalStorageSchemaType	Az elemzési tárolás sémáinak típusait ismerteti.

AnalyticalStorageSchemaType

Az elemzési tárolás sémáinak típusait ismerteti.

Name	Típus	Description
FullFidelity	string
WellDefined	string

ApiProperties

Name	Típus	Description
serverVersion	ServerVersion	Egy MongoDB-fiók ServerVersion-ját ismerteti.

BackupPolicyMigrationState

A biztonsági mentési szabályzatok közötti migrálás állapotát képviselő 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 szabályzattípusok 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 szabályzattípusok 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

A biztonsági mentési tár redundanciának típusának jelzésére szolgáló szám.

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 a "name": "EnableCassandra". Az aktuális értékek közé tartozik az "EnableTable" és az "EnableGremlin" is.

Capacity

Az objektum, amely a fiók kapacitás-kényszerítéséhez kapcsolódó összes tulajdonságot jelöli.

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ókra 2000-ra építhető ki. A totalThroughputLimit of -1 azt jelzi, hogy nincs korlátozva az átviteli sebesség kiépítése.

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 Bounded Staleness konzisztenciaszinttel van használva, ez az érték az elavultság (másodpercben) elviselhető időtartamát jelöli. Ennek az értéknek az elfogadott tartománya 5 – 86400. Akkor szükséges, ha a defaultConsistencyPolicy értéke "BoundedStaleness".
maxStalenessPrefix	integer	Ha a Bounded Staleness konzisztenciaszinttel van használva, ez az érték a tűrt elavult kérések számát jelöli. Ennek az értéknek az elfogadott tartománya 1 – 2 147 483 647. Akkor szükséges, 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 képviselő 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	Szám a folyamatos biztonsági mentési mód típusának jelzéséhez

ContinuousTier

Szám 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	A forrástartomány által a CORS-kérelmekhez használható metódusok (HTTP-kérési műveletek).
allowedOrigins	string	Azok a forrástartományok, amelyek 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éskibocsátónak.
maxAgeInSeconds	integer	Az a maximális 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

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

Name	Típus	Description
Default	string
Restore	string

DatabaseAccountCreateUpdateParameters

A Cosmos DB-adatbázisfiókok létrehozásához és frissítéséhez használandó paraméterek.

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. Jelenleg csak a MongoDB API-hoz támogatott.
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-fió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		Az adatbázis ajánlattípusa
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.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.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		Ezt a tulajdonságot a rendszer figyelmen kívül hagyja a frissítési/létrehozási művelet során, mivel a metaadatok írásvédettek. Az objektum a Cosmos DB-fiók fiókkulcsainak metaadatait jelöli.
properties.locations	Location[]		Egy tömb, amely a Cosmos DB-fiókhoz engedélyezett georeplicációs helyeket 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.publicNetworkAccess	PublicNetworkAccess		Engedélyezve vannak-e a nyilvános hálózatról érkező kérések
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.
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.

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		Engedélyezi az írási régió automatikus feladatátvételét abban a ritka esetben, amikor a régió kimaradá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 listája.
properties.isVirtualNetworkFilterEnabled	boolean		Jelölő, amely jelzi, hogy engedélyezni vagy 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 a következők 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 aktív használathoz. "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 sikertelen volt. "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

DatabaseRestoreResource

Adott visszaállítandó adatbázisok.

Name	Típus	Description
collectionNames	string[]	A visszaállításhoz elérhető gyűjtemények nevei.
databaseName	string	A visszaállításhoz elérhető 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

Egy 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 egy írási régiót jelöl. 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, amelybe 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ő grafikonok 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 tárolhatók 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 ezeket az IP-címszűrő nem érvényesítheti. 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 van 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 egy írási régiót jelöl. 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 a következők 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 aktív használathoz. "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 sikertelen volt. "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 fő 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 magában foglal egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is. 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árának kulcshivatkozásai a következő űrlapon található ARM-erőforrás-azonosítók: "/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 képviselő 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 időtartamot jelöli percekben
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égpontkapcsolat

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex – /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égpontkapcsolat 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égpontkapcsolat 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 privát kapcsolati szolgáltatás kapcsolati állapota.

PublicNetworkAccess

A nyilvános hálózatról érkező kérések engedélyezése

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 magában foglal egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is. 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 rendelkezésre álló adatbázisok listája.
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	A visszaállításhoz elérhető 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, amelyrő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 időpontja (ISO-8601 formátum).
tablesToRestore	string[]	A visszaállításhoz elérhető táblák listája.

ServerVersion

Egy MongoDB-fiók ServerVersion-já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 az identitás, amely legutóbb módosította az erőforrást.
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árának kulcshivatkozásai a következő űrlapon található ARM-erőforrás-azonosítók: "/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.