Database Accounts - Create Or Update

Hizmet:

Cosmos DB Resource Provider

API Sürümü:

2024-05-15

Azure Cosmos DB veritabanı hesabı oluşturur veya güncelleştirir. Bir hesapta güncelleştirmeler gerçekleştirilirken "Update" yöntemi tercih edilir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
accountName	path	True	string	Cosmos DB veritabanı hesap adı. Normal ifade deseni: ^[a-z0-9]+(-[a-z0-9]+)*
resourceGroupName	path	True	string	Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
properties.databaseAccountOfferType	True	DatabaseAccountOfferType	Veritabanı için teklif türü
properties.locations	True	Location[]	Cosmos DB hesabı için etkinleştirilen coğrafi çoğaltma konumlarını içeren bir dizi.
identity		ManagedServiceIdentity	Kaynağın kimliği.
kind		DatabaseAccountKind	Veritabanı hesabının türünü gösterir. Bu yalnızca veritabanı hesabı oluşturma sırasında ayarlanabilir.
location		string	Kaynağın ait olduğu kaynak grubunun konumu.
properties.analyticalStorageConfiguration		AnalyticalStorageConfiguration	Analitik depolamaya özgü özellikler.
properties.apiProperties		ApiProperties	API'ye özgü özellikler. Şu anda yalnızca MongoDB API'sinde desteklenmektedir.
properties.backupPolicy		BackupPolicy: PeriodicModeBackupPolicy ContinuousModeBackupPolicy	Bir hesapta yedek almak için ilkeyi temsil eden nesne.
properties.capabilities		Capability[]	Hesap için Cosmos DB özelliklerinin listesi
properties.capacity		Capacity	Bir hesapta kapasite zorlamayla ilgili tüm özellikleri temsil eden nesne.
properties.connectorOffer		ConnectorOffer	Cosmos DB veritabanı C* hesabı için cassandra bağlayıcısı teklif türü.
properties.consistencyPolicy		ConsistencyPolicy	Cosmos DB hesabı için tutarlılık ilkesi.
properties.cors		CorsPolicy[]	Cosmos DB veritabanı hesabı için CORS ilkesi.
properties.createMode		CreateMode	Hesap oluşturma modunu göstermek için sabit listesi.
properties.customerManagedKeyStatus		string	Hesapta Müşteri Tarafından Yönetilen Anahtar özelliğinin durumunu gösterir. Hata olması durumunda özelliği sorun giderme yönergeleri sağlar.
properties.defaultIdentity		string	Müşteri tarafından yönetilen anahtarlar gibi özelliklerde kullanılan anahtar kasasına erişmek için varsayılan kimlik. Varsayılan kimliğin kullanıcılar tarafından açıkça ayarlanması gerekir. "FirstPartyIdentity", "SystemAssignedIdentity" ve daha fazlası olabilir.
properties.disableKeyBasedMetadataWriteAccess		boolean	Hesap anahtarları aracılığıyla meta veri kaynaklarında (veritabanları, kapsayıcılar, aktarım hızı) yazma işlemlerini devre dışı bırakma
properties.disableLocalAuth		boolean	Yerel kimlik doğrulamasını geri çevirme ve yalnızca MSI ve AAD'nin yalnızca kimlik doğrulaması için kullanılabildiğinden emin olun.
properties.enableAnalyticalStorage		boolean	Depolama analizinin etkinleştirilip etkinleştirilmeydiğini gösteren bayrak.
properties.enableAutomaticFailover		boolean	Bir kesinti nedeniyle bölgenin kullanılamadığı nadir durumlarda yazma bölgesinin otomatik yük devretmesini etkinleştirir. Otomatik yük devretme, hesap için yeni bir yazma bölgesi oluşturur ve hesap için yapılandırılan yük devretme önceliklerine göre seçilir.
properties.enableBurstCapacity		boolean	Hesapta Seri Kapasite Önizleme özelliğinin etkinleştirilmesini/devre dışı bırakılmasını gösteren bayrak
properties.enableCassandraConnector		boolean	Cosmos DB C* hesabında cassandra bağlayıcısını etkinleştirir
properties.enableFreeTier		boolean	Ücretsiz Katmanın etkinleştirilip etkinleştirilmediğini gösteren bayrak.
properties.enableMultipleWriteLocations		boolean	Hesabın birden çok konumda yazmasına olanak tanır
properties.enablePartitionMerge		boolean	Hesapta Bölüm Birleştirme özelliğinin etkinleştirilmesini/devre dışı bırakılmasını gösteren bayrak
properties.ipRules		IpAddressOrRange[]	IpRules listesi.
properties.isVirtualNetworkFilterEnabled		boolean	Sanal Ağ ACL kurallarının etkinleştirilip etkinleştirilmeyip devre dışı bırakılmayacağını belirten bayrak.
properties.keyVaultKeyUri		string	Anahtar kasasının URI'si
properties.minimalTlsVersion		MinimalTlsVersion	İzin verilen en düşük Tls sürümünü gösterir. Varsayılan değer Tls 1.2'dir. Cassandra ve Mongo API'leri yalnızca Tls 1.2 ile çalışır.
properties.networkAclBypass		NetworkAclBypass	Güvenlik duvarı denetimlerini atlamak için izin verilen hizmetleri gösterir.
properties.networkAclBypassResourceIds		string[]	Cosmos DB hesabı için Ağ Acl Atlama kaynak kimliklerini içeren bir dizi.
properties.publicNetworkAccess		PublicNetworkAccess	Genel Ağdan gelen isteklere izin verilip verilmeyeceği
properties.restoreParameters		RestoreParameters	Geri yükleme hakkındaki bilgileri gösteren parametreler.
properties.virtualNetworkRules		VirtualNetworkRule[]	Cosmos DB hesabı için yapılandırılan Sanal Ağ ACL kurallarının listesi.
tags		object	Etiketler, kaynağı açıklayan anahtar-değer çiftlerinin listesidir. Bu etiketler, bu kaynağı görüntülemek ve gruplandırırken (kaynak grupları arasında) kullanılabilir. Bir kaynak için en fazla 15 etiket sağlanabilir. Her etiketin 128 karakterden büyük olmayan bir anahtarı ve 256 karakterden büyük olmayan bir değeri olmalıdır. Örneğin, şablon türü için varsayılan deneyim "defaultExperience": "Cassandra" ile ayarlanır. Geçerli "defaultExperience" değerleri ayrıca "Table", "Graph", "DocumentDB" ve "MongoDB" değerlerini de içerir.

Yanıtlar

Name	Tür	Description
200 OK	DatabaseAccountGetResults	Veritabanı hesabı oluşturma veya güncelleştirme işlemi zaman uyumsuz olarak tamamlanır.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	Kullanıcı hesabınızın kimliğine bürünme

Örnekler

CosmosDBDatabaseAccountCreateMax

CosmosDBDatabaseAccountCreateMin

CosmosDBRestoreDatabaseAccountCreateUpdate.json

CosmosDBDatabaseAccountCreateMax

Örnek isteği

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1?api-version=2024-05-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 typing import Any, IO, Union

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/2024-05-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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ec7ee8842bf615c2f0354bf8b5b8725fdac9454a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-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/2024-05-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

Örnek yanıt

Durum kodu:

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

Örnek isteği

HTTP

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

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

Python

from typing import Any, IO, Union

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/2024-05-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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ec7ee8842bf615c2f0354bf8b5b8725fdac9454a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-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/2024-05-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

Örnek yanıt

Durum kodu:

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

Örnek isteği

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1?api-version=2024-05-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 typing import Any, IO, Union

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/2024-05-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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ec7ee8842bf615c2f0354bf8b5b8725fdac9454a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-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/2024-05-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

Örnek yanıt

Durum kodu:

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

Tanımlar

Name	Description
AccountKeyMetadata	Belirli bir veritabanı hesabının erişim anahtarıyla ilgili meta veriler.
AnalyticalStorageConfiguration	Analitik depolamaya özgü özellikler.
AnalyticalStorageSchemaType	Analitik depolama için şema türlerini açıklar.
ApiProperties
BackupPolicyMigrationState	Yedekleme ilkeleri arasındaki geçişin durumunu temsil eden nesne.
BackupPolicyMigrationStatus	Yedekleme ilkesi türleri arasındaki geçişin durumunu açıklar.
BackupPolicyType	Yedeklemelerin modunu açıklar.
BackupStorageRedundancy	Yedekleme depolama yedekliliği türünü belirtmek için sabit listesi.
Capability	Cosmos DB yetenek nesnesi
Capacity	Bir hesapta kapasite zorlamayla ilgili tüm özellikleri temsil eden nesne.
ConnectorOffer	Cosmos DB C* veritabanı hesabı için cassandra bağlayıcısı teklif türü.
ConsistencyPolicy	Cosmos DB veritabanı hesabı için tutarlılık ilkesi.
ContinuousModeBackupPolicy	Sürekli mod yedekleme ilkesini temsil eden nesne.
ContinuousModeProperties	Düzenli mod yedeklemesi için yapılandırma değerleri
ContinuousTier	Sürekli yedekleme katmanının türünü belirtmek için sabit listesi.
CorsPolicy	Cosmos DB veritabanı hesabı için CORS ilkesi.
createdByType	Kaynağı oluşturan kimliğin türü.
CreateMode	Hesap oluşturma modunu göstermek için sabit listesi.
DatabaseAccountCreateUpdateParameters	Cosmos DB veritabanı hesaplarını oluşturmak ve güncelleştirmek için parametreler.
DatabaseAccountGetResults	Azure Cosmos DB veritabanı hesabı.
DatabaseAccountKeysMetadata	Verilen Cosmos DB veritabanı hesabının her erişim anahtarıyla ilgili meta veriler.
DatabaseAccountKind	Veritabanı hesabının türünü gösterir. Bu yalnızca veritabanı hesabı oluşturma sırasında ayarlanabilir.
DatabaseAccountOfferType	Cosmos DB veritabanı hesabının teklif türü.
DatabaseRestoreResource	Geri yükleneceği belirli Veritabanları.
DefaultConsistencyLevel	Cosmos DB hesabının varsayılan tutarlılık düzeyi ve yapılandırma ayarları.
FailoverPolicy	Veritabanı hesabının belirli bir bölgesi için yük devretme ilkesi.
GremlinDatabaseRestoreResource	Geri yükleneceği belirli Gremlin Veritabanları.
IpAddressOrRange	IpAddressOrRange nesnesi
Location	Azure Cosmos DB veritabanı hesabının dağıtıldığı bölge.
ManagedServiceIdentity	Kaynağın kimliği.
MinimalTlsVersion	İzin verilen en düşük Tls sürümünü gösterir. Varsayılan değer Tls 1.2'dir. Cassandra ve Mongo API'leri yalnızca Tls 1.2 ile çalışır.
NetworkAclBypass	Güvenlik duvarı denetimlerini atlamak için izin verilen hizmetleri gösterir.
PeriodicModeBackupPolicy	Düzenli mod yedekleme ilkesini temsil eden nesne.
PeriodicModeProperties	Düzenli mod yedeklemesi için yapılandırma değerleri
PrivateEndpointConnection	Özel uç nokta bağlantısı
PrivateEndpointProperty	Bağlantının ait olduğu özel uç nokta.
PrivateLinkServiceConnectionStateProperty	Özel Uç Nokta Bağlantısının Bağlantı Durumu.
PublicNetworkAccess	Genel Ağdan gelen isteklere izin verilip verilmeyeceği
ResourceIdentityType	Kaynak için kullanılan kimlik türü. 'SystemAssigned,UserAssigned' türü hem örtük olarak oluşturulmuş bir kimliği hem de kullanıcı tarafından atanan bir kimlik kümesini içerir. 'Hiçbiri' türü hizmetten tüm kimlikleri kaldırır.
RestoreMode	Geri yükleme modunu açıklar.
RestoreParameters	Geri yükleme hakkındaki bilgileri gösteren parametreler.
ServerVersion	Bir MongoDB hesabının ServerVersion'ını açıklar.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
UserAssignedIdentities	Kaynakla ilişkili kullanıcı kimliklerinin listesi. Kullanıcı kimliği sözlüğü anahtarı başvuruları şu formda ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
VirtualNetworkRule	ACL Kuralı nesnesini Sanal Ağ

AccountKeyMetadata

Belirli bir veritabanı hesabının erişim anahtarıyla ilgili meta veriler.

Name	Tür	Description
generationTime	string	ISO-8601 biçiminde anahtarın UTC olarak oluşturulması. nesnesinde değer eksikse, son anahtar yeniden oluşturma işleminin 2022-06-18'den önce tetiklenmiş olduğu anlamına gelir.

AnalyticalStorageConfiguration

Analitik depolamaya özgü özellikler.

Name	Tür	Description
schemaType	AnalyticalStorageSchemaType	Analitik depolama için şema türlerini açıklar.

AnalyticalStorageSchemaType

Analitik depolama için şema türlerini açıklar.

Name	Tür	Description
FullFidelity	string
WellDefined	string

ApiProperties

Name	Tür	Description
serverVersion	ServerVersion	MongoDB hesabının ServerVersion'ını açıklar.

BackupPolicyMigrationState

Yedekleme ilkeleri arasındaki geçişin durumunu temsil eden nesne.

Name	Tür	Description
startTime	string	Yedekleme ilkesi geçişinin başlatıldığı zaman (ISO-8601 biçimi).
status	BackupPolicyMigrationStatus	Yedekleme ilkesi türleri arasındaki geçişin durumunu açıklar.
targetType	BackupPolicyType	Yedekleme ilkesi geçişinin hedef yedekleme ilkesi türünü açıklar.

BackupPolicyMigrationStatus

Yedekleme ilkesi türleri arasındaki geçişin durumunu açıklar.

Name	Tür	Description
Completed	string
Failed	string
InProgress	string
Invalid	string

BackupPolicyType

Yedeklemelerin modunu açıklar.

Name	Tür	Description
Continuous	string
Periodic	string

BackupStorageRedundancy

Yedekleme depolama yedekliliği türünü belirtmek için sabit listesi.

Name	Tür	Description
Geo	string
Local	string
Zone	string

Capability

Cosmos DB yetenek nesnesi

Name	Tür	Description
name	string	Cosmos DB özelliğinin adı. Örneğin, "name": "EnableCassandra". Geçerli değerler "EnableTable" ve "EnableGremlin" değerlerini de içerir.

Capacity

Bir hesapta kapasite zorlamayla ilgili tüm özellikleri temsil eden nesne.

Name	Tür	Description
totalThroughputLimit	integer	Hesaba uygulanan toplam aktarım hızı sınırı. 2000'in totalThroughputLimit değeri, bu hesapta sağlanacak maksimum aktarım hızının 2000 olması için katı bir sınır uygular. -1 totalThroughputLimit değeri, aktarım hızının sağlanmasıyla ilgili bir sınır olmadığını gösterir.

ConnectorOffer

Cosmos DB C* veritabanı hesabı için cassandra bağlayıcısı teklif türü.

Name	Tür	Description
Small	string

ConsistencyPolicy

Cosmos DB veritabanı hesabı için tutarlılık ilkesi.

Name	Tür	Description
defaultConsistencyLevel	DefaultConsistencyLevel	Cosmos DB hesabının varsayılan tutarlılık düzeyi ve yapılandırma ayarları.
maxIntervalInSeconds	integer	Sınırlanmış Eskime tutarlılığı düzeyiyle kullanıldığında, bu değer tolere edilen eskime süresini (saniye cinsinden) temsil eder. Bu değer için kabul edilen aralık 5 - 86400'dür. defaultConsistencyPolicy 'BoundedStaleness' olarak ayarlandığında gereklidir.
maxStalenessPrefix	integer	Sınırlanmış Eskime tutarlılığı düzeyiyle kullanıldığında, bu değer tolere edilen eski isteklerin sayısını temsil eder. Bu değer için kabul edilen aralık 1 – 2.147.483.647'dir. defaultConsistencyPolicy 'BoundedStaleness' olarak ayarlandığında gereklidir.

ContinuousModeBackupPolicy

Sürekli mod yedekleme ilkesini temsil eden nesne.

Name	Tür	Description
continuousModeProperties	ContinuousModeProperties	Sürekli mod yedeklemesi için yapılandırma değerleri
migrationState	BackupPolicyMigrationState	Yedekleme ilkeleri arasındaki geçişin durumunu temsil eden nesne.
type	string: Continuous	Yedeklemelerin modunu açıklar.

ContinuousModeProperties

Düzenli mod yedeklemesi için yapılandırma değerleri

Name	Tür	Description
tier	ContinuousTier	Sürekli yedekleme modunun türünü belirtmek için sabit listesi

ContinuousTier

Sürekli yedekleme katmanının türünü belirtmek için sabit listesi.

Name	Tür	Description
Continuous30Days	string
Continuous7Days	string

CorsPolicy

Cosmos DB veritabanı hesabı için CORS ilkesi.

Name	Tür	Description
allowedHeaders	string	Kaynak etki alanının CORS isteğinde belirtebileceği istek üst bilgileri.
allowedMethods	string	Kaynak etki alanının bir CORS isteği için kullanabileceği yöntemler (HTTP istek fiilleri).
allowedOrigins	string	CORS aracılığıyla hizmete karşı istekte bulunmalarına izin verilen kaynak etki alanları.
exposedHeaders	string	CORS isteğine yanıt olarak gönderilebilen ve tarayıcı tarafından istek verene gösterilebilen yanıt üst bilgileri.
maxAgeInSeconds	integer	Bir tarayıcının denetim öncesi OPTIONS isteğini önbelleğe alması gereken en uzun süre.

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

Hesap oluşturma modunu göstermek için sabit listesi.

Name	Tür	Description
Default	string
Restore	string

DatabaseAccountCreateUpdateParameters

Cosmos DB veritabanı hesaplarını oluşturmak ve güncelleştirmek için parametreler.

Name	Tür	Default value	Description
id	string		ARM kaynağının benzersiz kaynak tanımlayıcısı.
identity	ManagedServiceIdentity		Kaynağın kimliği.
kind	DatabaseAccountKind	GlobalDocumentDB	Veritabanı hesabının türünü gösterir. Bu yalnızca veritabanı hesabı oluşturma sırasında ayarlanabilir.
location	string		Kaynağın ait olduğu kaynak grubunun konumu.
name	string		ARM kaynağının adı.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		Analitik depolamaya özgü özellikler.
properties.apiProperties	ApiProperties		API'ye özgü özellikler. Şu anda yalnızca MongoDB API'sinde desteklenmektedir.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy		Bir hesapta yedekleme almak için ilkeyi temsil eden nesne.
properties.capabilities	Capability[]		Hesap için Cosmos DB özelliklerinin listesi
properties.capacity	Capacity		Bir hesapta kapasite zorlamayla ilgili tüm özellikleri temsil eden nesne.
properties.connectorOffer	ConnectorOffer		Cosmos DB veritabanı C* hesabı için cassandra bağlayıcısı teklif türü.
properties.consistencyPolicy	ConsistencyPolicy		Cosmos DB hesabı için tutarlılık ilkesi.
properties.cors	CorsPolicy[]		Cosmos DB veritabanı hesabı için CORS ilkesi.
properties.createMode	CreateMode	Default	Hesap oluşturma modunu belirtmek için sabit listesi.
properties.customerManagedKeyStatus	string		Hesapta Müşteri Tarafından Yönetilen Anahtar özelliğinin durumunu gösterir. Hatalar olması durumunda özelliği sorun giderme yönergeleri sağlar.
properties.databaseAccountOfferType	DatabaseAccountOfferType		Veritabanı için teklif türü
properties.defaultIdentity	string		Müşteri tarafından yönetilen anahtarlar gibi özelliklerde kullanılan anahtar kasasına erişmek için varsayılan kimlik. Varsayılan kimliğin kullanıcılar tarafından açıkça ayarlanması gerekir. "FirstPartyIdentity", "SystemAssignedIdentity" ve daha fazlası olabilir.
properties.disableKeyBasedMetadataWriteAccess	boolean		Hesap anahtarları aracılığıyla meta veri kaynaklarında (veritabanları, kapsayıcılar, aktarım hızı) yazma işlemlerini devre dışı bırakma
properties.disableLocalAuth	boolean		Yerel kimlik doğrulamasını geri çevirme ve yalnızca MSI ve AAD'nin yalnızca kimlik doğrulaması için kullanılabildiğinden emin olun.
properties.enableAnalyticalStorage	boolean		Depolama analizinin etkinleştirilip etkinleştirilmeydiğini belirten bayrak.
properties.enableAutomaticFailover	boolean		Bölgenin kesinti nedeniyle kullanılamadığı nadir durumlarda yazma bölgesinin otomatik yük devretmesini etkinleştirir. Otomatik yük devretme, hesap için yeni bir yazma bölgesi oluşturur ve hesap için yapılandırılan yük devretme önceliklerine göre seçilir.
properties.enableBurstCapacity	boolean		Hesapta Seri Kapasite Önizleme özelliğinin etkinleştirilmesini/devre dışı bırakılmasını belirten bayrak
properties.enableCassandraConnector	boolean		Cosmos DB C* hesabında cassandra bağlayıcısını etkinleştirir
properties.enableFreeTier	boolean		Ücretsiz Katmanın etkinleştirilip etkinleştirilmediğini belirten bayrak.
properties.enableMultipleWriteLocations	boolean		Hesabın birden çok konumda yazmasına olanak tanır
properties.enablePartitionMerge	boolean		Hesapta Bölüm Birleştirme özelliğinin etkinleştirilmesini/devre dışı bırakılmasını belirten bayrak
properties.ipRules	IpAddressOrRange[]		IpRules listesi.
properties.isVirtualNetworkFilterEnabled	boolean		Sanal Ağ ACL kurallarının etkinleştirilip etkinleştirilmediğini/devre dışı bırakılıp bırakılmayacağını belirten bayrak.
properties.keyVaultKeyUri	string		Anahtar kasasının URI'si
properties.keysMetadata	DatabaseAccountKeysMetadata		Meta veriler salt okunur olduğundan güncelleştirme/oluşturma işlemi sırasında bu özellik yoksayılır. nesnesi, Cosmos DB hesabının Hesap Anahtarları için meta verileri temsil eder.
properties.locations	Location[]		Cosmos DB hesabı için etkinleştirilen coğrafi çoğaltma konumlarını içeren bir dizi.
properties.minimalTlsVersion	MinimalTlsVersion		İzin verilen en düşük Tls sürümünü gösterir. Varsayılan değer Tls 1.2'dir. Cassandra ve Mongo API'leri yalnızca Tls 1.2 ile çalışır.
properties.networkAclBypass	NetworkAclBypass		Güvenlik duvarı denetimlerini atlamak için izin verilen hizmetleri gösterir.
properties.networkAclBypassResourceIds	string[]		Cosmos DB hesabı için Ağ Acl'si Atlama için Kaynak Kimliklerini içeren bir dizi.
properties.publicNetworkAccess	PublicNetworkAccess		Genel Ağdan gelen isteklere izin verilip verilmeyeceği
properties.restoreParameters	RestoreParameters		Geri yükleme hakkındaki bilgileri gösteren parametreler.
properties.virtualNetworkRules	VirtualNetworkRule[]		Cosmos DB hesabı için yapılandırılan Sanal Ağ ACL kurallarının listesi.
tags	object		Etiketler, kaynağı açıklayan anahtar-değer çiftlerinin listesidir. Bu etiketler, bu kaynağı (kaynak grupları arasında) görüntüleme ve gruplandırma işlemlerinde kullanılabilir. Bir kaynak için en fazla 15 etiket sağlanabilir. Her etiketin 128 karakterden büyük olmayan bir anahtarı ve 256 karakterden büyük olmayan bir değeri olmalıdır. Örneğin, şablon türü için varsayılan deneyim "defaultExperience": "Cassandra" ile ayarlanır. Geçerli "defaultExperience" değerleri "Tablo", "Graph", "DocumentDB" ve "MongoDB" değerlerini de içerir.
type	string		Azure kaynağının türü.

DatabaseAccountGetResults

Azure Cosmos DB veritabanı hesabı.

Name	Tür	Default value	Description
id	string		ARM kaynağının benzersiz kaynak tanımlayıcısı.
identity	ManagedServiceIdentity		Kaynağın kimliği.
kind	DatabaseAccountKind	GlobalDocumentDB	Veritabanı hesabının türünü gösterir. Bu yalnızca veritabanı hesabı oluşturma sırasında ayarlanabilir.
location	string		Kaynağın ait olduğu kaynak grubunun konumu.
name	string		ARM kaynağının adı.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		Analitik depolamaya özgü özellikler.
properties.apiProperties	ApiProperties		API'ye özgü özellikler.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy		Bir hesapta yedekleme almak için ilkeyi temsil eden nesne.
properties.capabilities	Capability[]		Hesap için Cosmos DB özelliklerinin listesi
properties.capacity	Capacity		Bir hesapta kapasite zorlamayla ilgili tüm özellikleri temsil eden nesne.
properties.connectorOffer	ConnectorOffer		Cosmos DB veritabanı C* hesabı için cassandra bağlayıcısı teklif türü.
properties.consistencyPolicy	ConsistencyPolicy		Cosmos DB veritabanı hesabı için tutarlılık ilkesi.
properties.cors	CorsPolicy[]		Cosmos DB veritabanı hesabı için CORS ilkesi.
properties.createMode	CreateMode	Default	Hesap oluşturma modunu belirtmek için sabit listesi.
properties.customerManagedKeyStatus	string		Hesapta Müşteri Tarafından Yönetilen Anahtar özelliğinin durumunu gösterir. Hatalar olması durumunda özelliği sorun giderme yönergeleri sağlar.
properties.databaseAccountOfferType	DatabaseAccountOfferType		Cosmos DB veritabanı hesabının teklif türü. Varsayılan değer: Standart.
properties.defaultIdentity	string		Müşteri tarafından yönetilen anahtarlar gibi özelliklerde kullanılan anahtar kasasına erişmek için varsayılan kimlik. Varsayılan kimliğin kullanıcılar tarafından açıkça ayarlanması gerekir. "FirstPartyIdentity", "SystemAssignedIdentity" ve daha fazlası olabilir.
properties.disableKeyBasedMetadataWriteAccess	boolean		Hesap anahtarları aracılığıyla meta veri kaynaklarında (veritabanları, kapsayıcılar, aktarım hızı) yazma işlemlerini devre dışı bırakma
properties.disableLocalAuth	boolean		Yerel kimlik doğrulamasını geri çevirme ve yalnızca MSI ve AAD'nin yalnızca kimlik doğrulaması için kullanılabildiğinden emin olun.
properties.documentEndpoint	string		Cosmos DB veritabanı hesabının bağlantı uç noktası.
properties.enableAnalyticalStorage	boolean		Depolama analizinin etkinleştirilip etkinleştirilmeydiğini belirten bayrak.
properties.enableAutomaticFailover	boolean		Bölgenin kesinti nedeniyle kullanılamadığı nadir durumlarda yazma bölgesinin otomatik yük devretmesini etkinleştirir. Otomatik yük devretme, hesap için yeni bir yazma bölgesi oluşturur ve hesap için yapılandırılan yük devretme önceliklerine göre seçilir.
properties.enableBurstCapacity	boolean		Hesapta Seri Kapasite Önizleme özelliğinin etkinleştirilmesini/devre dışı bırakılmasını belirten bayrak
properties.enableCassandraConnector	boolean		Cosmos DB C* hesabında cassandra bağlayıcısını etkinleştirir
properties.enableFreeTier	boolean		Ücretsiz Katmanın etkinleştirilip etkinleştirilmediğini belirten bayrak.
properties.enableMultipleWriteLocations	boolean		Hesabın birden çok konumda yazmasına olanak tanır
properties.enablePartitionMerge	boolean		Hesapta Bölüm Birleştirme özelliğinin etkinleştirilmesini/devre dışı bırakılmasını belirten bayrak
properties.failoverPolicies	FailoverPolicy[]		Yük devretme önceliklerine göre sıralanmış bölgeleri içeren bir dizi.
properties.instanceId	string		Veritabanı hesabına atanan benzersiz tanımlayıcı
properties.ipRules	IpAddressOrRange[]		IpRules listesi.
properties.isVirtualNetworkFilterEnabled	boolean		Sanal Ağ ACL kurallarının etkinleştirilip etkinleştirilmediğini/devre dışı bırakılıp bırakılmayacağını belirten bayrak.
properties.keyVaultKeyUri	string		Anahtar kasasının URI'si
properties.keysMetadata	DatabaseAccountKeysMetadata		Cosmos DB hesabının Hesap Anahtarları için meta verileri temsil eden nesne.
properties.locations	Location[]		Cosmos DB hesabı için etkinleştirilen tüm konumları içeren bir dizi.
properties.minimalTlsVersion	MinimalTlsVersion		İzin verilen en düşük Tls sürümünü gösterir. Varsayılan değer Tls 1.2'dir. Cassandra ve Mongo API'leri yalnızca Tls 1.2 ile çalışır.
properties.networkAclBypass	NetworkAclBypass		Güvenlik duvarı denetimlerini atlamak için izin verilen hizmetleri gösterir.
properties.networkAclBypassResourceIds	string[]		Cosmos DB hesabı için Ağ Acl'si Atlama için Kaynak Kimliklerini içeren bir dizi.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Cosmos DB hesabı için yapılandırılmış Özel Uç Nokta Connections listesi.
properties.provisioningState	string		İşlem çağrıldığında Cosmos DB hesabının durumu. Durum aşağıdakilerden biri olabilir. 'Oluşturuluyor' – Cosmos DB hesabı oluşturuluyor. Hesap Oluşturma durumundayken, yalnızca İçerik Oluşturucu Cosmos DB hesap işlemi için giriş olarak belirtilen özellikler döndürülür. 'Başarılı' – Cosmos DB hesabı kullanım için etkindir. 'Güncelleştirme' – Cosmos DB hesabı güncelleştiriliyor. 'Silme' – Cosmos DB hesabı siliniyor. 'Başarısız' – Cosmos DB hesabı oluşturulamadı. 'DeletionFailed' – Cosmos DB hesabı silinemedi.
properties.publicNetworkAccess	PublicNetworkAccess		Genel Ağdan gelen isteklere izin verilip verilmeyeceği
properties.readLocations	Location[]		Cosmos DB hesabı için etkinleştirilmiş okuma konumlarını içeren bir dizi.
properties.restoreParameters	RestoreParameters		Geri yükleme hakkındaki bilgileri gösteren parametreler.
properties.virtualNetworkRules	VirtualNetworkRule[]		Cosmos DB hesabı için yapılandırılan Sanal Ağ ACL kurallarının listesi.
properties.writeLocations	Location[]		Cosmos DB hesabının yazma konumunu içeren bir dizi.
systemData	systemData		Bu kaynakla ilgili sistem meta verileri.
tags	object		Etiketler, kaynağı açıklayan anahtar-değer çiftlerinin listesidir. Bu etiketler, bu kaynağı (kaynak grupları arasında) görüntüleme ve gruplandırma işlemlerinde kullanılabilir. Bir kaynak için en fazla 15 etiket sağlanabilir. Her etiketin 128 karakterden büyük olmayan bir anahtarı ve 256 karakterden büyük olmayan bir değeri olmalıdır. Örneğin, şablon türü için varsayılan deneyim "defaultExperience": "Cassandra" ile ayarlanır. Geçerli "defaultExperience" değerleri "Tablo", "Graph", "DocumentDB" ve "MongoDB" değerlerini de içerir.
type	string		Azure kaynağının türü.

DatabaseAccountKeysMetadata

Verilen Cosmos DB veritabanı hesabının her erişim anahtarıyla ilgili meta veriler.

Name	Tür	Description
primaryMasterKey	AccountKeyMetadata	Verilen Cosmos DB veritabanı hesabının Birincil Read-Write Anahtarı ile ilgili meta veriler.
primaryReadonlyMasterKey	AccountKeyMetadata	Verilen Cosmos DB veritabanı hesabının Birincil Read-Only Anahtarı ile ilgili meta veriler.
secondaryMasterKey	AccountKeyMetadata	Verilen Cosmos DB veritabanı hesabının İkincil Read-Write Anahtarı ile ilgili meta veriler.
secondaryReadonlyMasterKey	AccountKeyMetadata	Verilen Cosmos DB veritabanı hesabının İkincil Read-Only Anahtarı ile ilgili meta veriler.

DatabaseAccountKind

Veritabanı hesabının türünü gösterir. Bu yalnızca veritabanı hesabı oluşturma sırasında ayarlanabilir.

Name	Tür	Description
GlobalDocumentDB	string
MongoDB	string
Parse	string

DatabaseAccountOfferType

Cosmos DB veritabanı hesabının teklif türü.

Name	Tür	Description
Standard	string

DatabaseRestoreResource

Geri yükleneceği belirli Veritabanları.

Name	Tür	Description
collectionNames	string[]	Geri yükleme için kullanılabilen koleksiyonların adları.
databaseName	string	Geri yükleme için kullanılabilen veritabanının adı.

DefaultConsistencyLevel

Cosmos DB hesabının varsayılan tutarlılık düzeyi ve yapılandırma ayarları.

Name	Tür	Description
BoundedStaleness	string
ConsistentPrefix	string
Eventual	string
Session	string
Strong	string

FailoverPolicy

Veritabanı hesabının belirli bir bölgesi için yük devretme ilkesi.

Name	Tür	Description
failoverPriority	integer	Bölgenin yük devretme önceliği. 0 yük devretme önceliği yazma bölgesini gösterir. Yük devretme önceliği için en büyük değer = (toplam bölge sayısı - 1). Yük devretme öncelik değerleri, veritabanı hesabının bulunduğu bölgelerin her biri için benzersiz olmalıdır.
id	string	Veritabanı hesabının çoğaltıldığı bölgenin benzersiz tanımlayıcısı. Örnek: <accountName-locationName>><.
locationName	string	Veritabanı hesabının bulunduğu bölgenin adı.

GremlinDatabaseRestoreResource

Geri yükleneceği belirli Gremlin Veritabanları.

Name	Tür	Description
databaseName	string	Geri yükleme için kullanılabilen gremlin veritabanının adı.
graphNames	string[]	Geri yükleme için kullanılabilecek grafiklerin adları.

IpAddressOrRange

IpAddressOrRange nesnesi

Name	Tür	Description
ipAddressOrRange	string	Tek bir IPv4 adresi veya CIDR biçiminde tek bir IPv4 adres aralığı. IP'lerin iyi biçimlendirilmiş olması ve şu aralıklardan birinde bulunamaması gerekir: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16. Geçerli giriş örneği: "23.40.210.245" veya "23.40.210.0/8".

Location

Azure Cosmos DB veritabanı hesabının dağıtıldığı bölge.

Name	Tür	Description
documentEndpoint	string	Belirli bir bölge için bağlantı uç noktası. Örnek: https://< accountName-locationName.documents.azure.com:443/><>
failoverPriority	integer	Bölgenin yük devretme önceliği. 0 yük devretme önceliği yazma bölgesini gösterir. Yük devretme önceliği için en büyük değer = (toplam bölge sayısı - 1). Yük devretme önceliği değerleri, veritabanı hesabının bulunduğu bölgelerin her biri için benzersiz olmalıdır.
id	string	Veritabanı hesabındaki bölgenin benzersiz tanımlayıcısı. Örnek: <accountName-locationName>><.
isZoneRedundant	boolean	Bu bölgenin bir AvailabilityZone bölgesi olup olmadığını belirten bayrak
locationName	string	Bölgenin adı.
provisioningState	string	İşlem çağrıldığında Cosmos DB hesabının durumu. Durum aşağıdakilerden biri olabilir. 'Oluşturuluyor' – Cosmos DB hesabı oluşturuluyor. Hesap Oluşturma durumundayken, yalnızca İçerik Oluşturucu Cosmos DB hesap işlemi için giriş olarak belirtilen özellikler döndürülür. 'Başarılı' – Cosmos DB hesabı kullanım için etkindir. 'Güncelleştirme' – Cosmos DB hesabı güncelleştiriliyor. 'Silme' – Cosmos DB hesabı siliniyor. 'Başarısız' – Cosmos DB hesabı oluşturulamadı. 'DeletionFailed' – Cosmos DB hesabı silinemedi.

ManagedServiceIdentity

Kaynağın kimliği.

Name	Tür	Description
principalId	string	Sistem tarafından atanan kimliğin asıl kimliği. Bu özellik yalnızca sistem tarafından atanan kimlik için sağlanacaktır.
tenantId	string	Sistem tarafından atanan kimliğin kiracı kimliği. Bu özellik yalnızca sistem tarafından atanan kimlik için sağlanacaktır.
type	ResourceIdentityType	Kaynak için kullanılan kimlik türü. 'SystemAssigned,UserAssigned' türü hem örtük olarak oluşturulmuş bir kimlik hem de kullanıcı tarafından atanan kimlikler kümesini içerir. 'Hiçbiri' türü hizmetten tüm kimlikleri kaldırır.
userAssignedIdentities	UserAssignedIdentities	Kaynakla ilişkilendirilmiş kullanıcı kimliklerinin listesi. Kullanıcı kimliği sözlüğü anahtar başvuruları şu biçimde ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

MinimalTlsVersion

İzin verilen en düşük Tls sürümünü gösterir. Varsayılan değer Tls 1.2'dir. Cassandra ve Mongo API'leri yalnızca Tls 1.2 ile çalışır.

Name	Tür	Description
Tls	string
Tls11	string
Tls12	string

NetworkAclBypass

Güvenlik duvarı denetimlerini atlamak için izin verilen hizmetleri gösterir.

Name	Tür	Description
AzureServices	string
None	string

PeriodicModeBackupPolicy

Düzenli mod yedekleme ilkesini temsil eden nesne.

Name	Tür	Description
migrationState	BackupPolicyMigrationState	Yedekleme ilkeleri arasındaki geçişin durumunu temsil eden nesne.
periodicModeProperties	PeriodicModeProperties	Düzenli mod yedeklemesi için yapılandırma değerleri
type	string: Periodic	Yedeklemelerin modunu açıklar.

PeriodicModeProperties

Düzenli mod yedeklemesi için yapılandırma değerleri

Name	Tür	Description
backupIntervalInMinutes	integer	İki yedekleme arasındaki aralığı dakika cinsinden gösteren bir tamsayı
backupRetentionIntervalInHours	integer	Her yedeklemenin tutulduğunu saati (saat cinsinden) gösteren bir tamsayı
backupStorageRedundancy	BackupStorageRedundancy	Yedekleme yerleşimi türünü göstermek için sabit listesi

PrivateEndpointConnection

Özel uç nokta bağlantısı

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Kaynağın adı
properties.groupId	string	Özel uç noktanın grup kimliği.
properties.privateEndpoint	PrivateEndpointProperty	Bağlantının ait olduğu özel uç nokta.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Özel Uç Nokta Bağlantısının Bağlantı Durumu.
properties.provisioningState	string	Özel uç noktanın sağlama durumu.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

Bağlantının ait olduğu özel uç nokta.

Name	Tür	Description
id	string	Özel uç noktanın kaynak kimliği.

PrivateLinkServiceConnectionStateProperty

Özel Uç Nokta Bağlantısının Bağlantı Durumu.

Name	Tür	Description
actionsRequired	string	Temel iş akışının ötesinde gerekli olan tüm eylemler (onaylama/ reddetme/bağlantıyı kesme)
description	string	Özel bağlantı hizmeti bağlantı açıklaması.
status	string	Özel bağlantı hizmeti bağlantı durumu.

PublicNetworkAccess

Genel Ağdan gelen isteklere izin verilip verilmeyeceği

Name	Tür	Description
Disabled	string
Enabled	string
SecuredByPerimeter	string

ResourceIdentityType

Kaynak için kullanılan kimlik türü. 'SystemAssigned,UserAssigned' türü hem örtük olarak oluşturulmuş bir kimliği hem de kullanıcı tarafından atanan bir kimlik kümesini içerir. 'Hiçbiri' türü hizmetten tüm kimlikleri kaldırır.

Name	Tür	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

RestoreMode

Geri yükleme modunu açıklar.

Name	Tür	Description
PointInTime	string

RestoreParameters

Geri yükleme hakkındaki bilgileri gösteren parametreler.

Name	Tür	Description
databasesToRestore	DatabaseRestoreResource[]	Geri yükleme için kullanılabilen belirli veritabanlarının listesi.
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	Geri yükleme için kullanılabilen belirli gremlin veritabanlarının listesi.
restoreMode	RestoreMode	Geri yükleme modunu açıklar.
restoreSource	string	Geri yüklemenin başlatılması gereken geri yüklenebilir veritabanı hesabının kimliği. Örneğin: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restoreableDatabaseAccounts/{restoreableDatabaseAccountName}
restoreTimestampInUtc	string	Hesabın geri yüklenmesi gereken süre (ISO-8601 biçimi).
tablesToRestore	string[]	Geri yükleme için kullanılabilen belirli tabloların listesi.

ServerVersion

Bir MongoDB hesabının ServerVersion'ını açıklar.

Name	Tür	Description
3.2	string
3.6	string
4.0	string
4.2	string
5.0	string
6.0	string

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.

UserAssignedIdentities

Kaynakla ilişkili kullanıcı kimliklerinin listesi. Kullanıcı kimliği sözlüğü anahtarı başvuruları şu formda ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name	Tür	Description

VirtualNetworkRule

ACL Kuralı nesnesini Sanal Ağ

Name	Tür	Description
id	string	Bir alt ağın kaynak kimliği, örneğin: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignoreMissingVNetServiceEndpoint	boolean	Sanal ağda sanal ağ hizmet uç noktası etkinleştirilmeden önce güvenlik duvarı kuralını İçerik Oluşturucu.