Database Accounts - Create Or Update

Service:

Cosmos DB Resource Provider

API Version:

2023-11-15

Membuat atau memperbarui akun database Azure Cosmos DB. Metode "Perbarui" lebih disukai saat melakukan pembaruan pada akun.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountName	path	True	string	Nama akun database Cosmos DB. Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
properties.databaseAccountOfferType	True	DatabaseAccountOfferType	Jenis penawaran untuk database
properties.locations	True	Location[]	Array yang berisi lokasi georeplikasi yang diaktifkan untuk akun Cosmos DB.
identity		ManagedServiceIdentity	Identitas untuk sumber daya.
kind		DatabaseAccountKind	Menunjukkan jenis akun database. Ini hanya dapat diatur pada pembuatan akun database.
location		string	Lokasi grup sumber daya tempat sumber daya berada.
properties.analyticalStorageConfiguration		AnalyticalStorageConfiguration	Properti khusus penyimpanan analitis.
properties.apiProperties		ApiProperties	Properti khusus API. Saat ini, hanya didukung untuk MongoDB API.
properties.backupPolicy		BackupPolicy: PeriodicModeBackupPolicy ContinuousModeBackupPolicy	Objek yang mewakili kebijakan untuk mengambil cadangan pada akun.
properties.capabilities		Capability[]	Daftar kemampuan Cosmos DB untuk akun
properties.capacity		Capacity	Objek yang mewakili semua properti yang terkait dengan penegakan kapasitas pada akun.
properties.connectorOffer		ConnectorOffer	Jenis penawaran konektor cassandra untuk akun C* database Cosmos DB.
properties.consistencyPolicy		ConsistencyPolicy	Kebijakan konsistensi untuk akun Cosmos DB.
properties.cors		CorsPolicy[]	Kebijakan CORS untuk akun database Cosmos DB.
properties.createMode		CreateMode	Enum untuk menunjukkan mode pembuatan akun.
properties.customerManagedKeyStatus		string	Menunjukkan status fitur Kunci yang Dikelola Pelanggan di akun. Jika ada kesalahan, properti menyediakan panduan pemecahan masalah.
properties.defaultIdentity		string	Identitas default untuk mengakses brankas kunci yang digunakan dalam fitur seperti kunci yang dikelola pelanggan. Identitas default harus diatur secara eksplisit oleh pengguna. Ini bisa menjadi "FirstPartyIdentity", "SystemAssignedIdentity" dan banyak lagi.
properties.disableKeyBasedMetadataWriteAccess		boolean	Menonaktifkan operasi tulis pada sumber daya metadata (database, kontainer, throughput) melalui kunci akun
properties.disableLocalAuth		boolean	Menolak autentikasi lokal dan memastikan hanya MSI dan AAD yang dapat digunakan secara eksklusif untuk autentikasi.
properties.enableAnalyticalStorage		boolean	Bendera untuk menunjukkan apakah akan mengaktifkan analitik penyimpanan.
properties.enableAutomaticFailover		boolean	Mengaktifkan failover otomatis wilayah tulis jika wilayah tersebut tidak tersedia karena pemadaman. Failover otomatis akan menghasilkan wilayah tulis baru untuk akun dan dipilih berdasarkan prioritas failover yang dikonfigurasi untuk akun tersebut.
properties.enableBurstCapacity		boolean	Bendera untuk menunjukkan pengaktifan/penonaktifan fitur Pratinjau Kapasitas Burst pada akun
properties.enableCassandraConnector		boolean	Mengaktifkan konektor cassandra pada akun Cosmos DB C*
properties.enableFreeTier		boolean	Bendera untuk menunjukkan apakah Tingkat Gratis diaktifkan.
properties.enableMultipleWriteLocations		boolean	Mengaktifkan akun untuk menulis di beberapa lokasi
properties.enablePartitionMerge		boolean	Bendera untuk menunjukkan pengaktifan/penonaktifan fitur Penggabungan Partisi pada akun
properties.ipRules		IpAddressOrRange[]	Daftar IpRules.
properties.isVirtualNetworkFilterEnabled		boolean	Bendera untuk menunjukkan apakah akan mengaktifkan/menonaktifkan aturan ACL Virtual Network.
properties.keyVaultKeyUri		string	URI brankas kunci
properties.minimalTlsVersion		MinimalTlsVersion	Menunjukkan versi Tls minimum yang diizinkan. Nilai defaultnya adalah Tls 1.2. API Cassandra dan Mongo hanya berfungsi dengan Tls 1.2.
properties.networkAclBypass		NetworkAclBypass	Menunjukkan layanan apa yang diizinkan untuk melewati pemeriksaan firewall.
properties.networkAclBypassResourceIds		string[]	Array yang berisi Id Sumber Daya untuk Bypass Acl Jaringan untuk akun Cosmos DB.
properties.publicNetworkAccess		PublicNetworkAccess	Apakah permintaan dari Jaringan Publik diizinkan
properties.restoreParameters		RestoreParameters	Parameter untuk menunjukkan informasi tentang pemulihan.
properties.virtualNetworkRules		VirtualNetworkRule[]	Daftar aturan ACL Virtual Network yang dikonfigurasi untuk akun Cosmos DB.
tags		object	Tag adalah daftar pasangan kunci-nilai yang menjelaskan sumber daya. Tag ini dapat digunakan dalam menampilkan dan mengelompokkan sumber daya ini (di seluruh grup sumber daya). Maksimal 15 tag dapat disediakan untuk sumber daya. Setiap tag harus memiliki kunci yang tidak lebih besar dari 128 karakter dan nilai tidak lebih besar dari 256 karakter. Misalnya, pengalaman default untuk jenis templat diatur dengan "defaultExperience": "Cassandra". Nilai "defaultExperience" saat ini juga mencakup "Table", "Graph", "DocumentDB", dan "MongoDB".

Respons

Nama	Jenis	Deskripsi
200 OK	DatabaseAccountGetResults	Operasi pembuatan atau pembaruan akun database akan selesai secara asinkron.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
user_impersonation	Meniru akun pengguna Anda

Contoh

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

Definisi

Nama	Deskripsi
AccountKeyMetadata	Metadata yang terkait dengan kunci akses untuk akun database tertentu.
AnalyticalStorageConfiguration	Properti khusus penyimpanan analitis.
AnalyticalStorageSchemaType	Menjelaskan jenis skema untuk penyimpanan analitis.
ApiProperties
BackupPolicyMigrationState	Objek yang mewakili status migrasi antara kebijakan pencadangan.
BackupPolicyMigrationStatus	Menjelaskan status migrasi antar jenis kebijakan pencadangan.
BackupPolicyType	Menjelaskan mode pencadangan.
BackupStorageRedundancy	Enum untuk menunjukkan jenis redundansi penyimpanan cadangan.
Capability	Objek kemampuan Cosmos DB
Capacity	Objek yang mewakili semua properti yang terkait dengan penegakan kapasitas pada akun.
ConnectorOffer	Jenis penawaran konektor cassandra untuk akun database Cosmos DB C*.
ConsistencyPolicy	Kebijakan konsistensi untuk akun database Cosmos DB.
ContinuousModeBackupPolicy	Objek yang mewakili kebijakan pencadangan mode berkelanjutan.
ContinuousModeProperties	Nilai konfigurasi untuk pencadangan mode berkala
ContinuousTier	Enum untuk menunjukkan jenis tingkat pencadangan berkelanjutan.
CorsPolicy	Kebijakan CORS untuk akun database Cosmos DB.
createdByType	Jenis identitas yang membuat sumber daya.
CreateMode	Enum untuk menunjukkan mode pembuatan akun.
DatabaseAccountCreateUpdateParameters	Parameter untuk membuat dan memperbarui akun database Cosmos DB.
DatabaseAccountGetResults	Akun database Azure Cosmos DB.
DatabaseAccountKeysMetadata	Metadata yang terkait dengan setiap kunci akses untuk akun database Cosmos DB yang diberikan.
DatabaseAccountKind	Menunjukkan jenis akun database. Ini hanya dapat diatur pada pembuatan akun database.
DatabaseAccountOfferType	Jenis penawaran untuk akun database Cosmos DB.
DatabaseRestoreResource	Database Tertentu untuk dipulihkan.
DefaultConsistencyLevel	Tingkat konsistensi default dan pengaturan konfigurasi akun Cosmos DB.
FailoverPolicy	Kebijakan failover untuk wilayah tertentu dari akun database.
GremlinDatabaseRestoreResource	Database Gremlin tertentu untuk dipulihkan.
IpAddressOrRange	Objek IpAddressOrRange
Location	Wilayah tempat akun database Azure Cosmos DB disebarkan.
ManagedServiceIdentity	Identitas untuk sumber daya.
MinimalTlsVersion	Menunjukkan versi Tls minimum yang diizinkan. Nilai defaultnya adalah Tls 1.2. API Cassandra dan Mongo hanya berfungsi dengan Tls 1.2.
NetworkAclBypass	Menunjukkan layanan apa yang diizinkan untuk melewati pemeriksaan firewall.
PeriodicModeBackupPolicy	Objek yang mewakili kebijakan pencadangan mode berkala.
PeriodicModeProperties	Nilai konfigurasi untuk pencadangan mode berkala
PrivateEndpointConnection	Koneksi titik akhir privat
PrivateEndpointProperty	Titik akhir privat tempat koneksi berada.
PrivateLinkServiceConnectionStateProperty	Status Koneksi Koneksi Titik Akhir Privat.
PublicNetworkAccess	Apakah permintaan dari Jaringan Publik diizinkan
ResourceIdentityType	Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned,UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun dari layanan.
RestoreMode	Menjelaskan mode pemulihan.
RestoreParameters	Parameter untuk menunjukkan informasi tentang pemulihan.
ServerVersion	Menjelaskan ServerVersion dari akun MongoDB.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
UserAssignedIdentities	Daftar identitas pengguna yang terkait dengan sumber daya. Referensi kunci kamus identitas pengguna akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
VirtualNetworkRule	Virtual Network objek Aturan ACL

AccountKeyMetadata

Metadata yang terkait dengan kunci akses untuk akun database tertentu.

Nama	Jenis	Deskripsi
generationTime	string	Waktu pembuatan dalam UTC kunci dalam format ISO-8601. Jika nilai hilang dari objek , itu berarti bahwa regenerasi kunci terakhir dipicu sebelum 2022-06-18.

AnalyticalStorageConfiguration

Properti khusus penyimpanan analitis.

Nama	Jenis	Deskripsi
schemaType	AnalyticalStorageSchemaType	Menjelaskan jenis skema untuk penyimpanan analitis.

AnalyticalStorageSchemaType

Menjelaskan jenis skema untuk penyimpanan analitis.

Nama	Jenis	Deskripsi
FullFidelity	string
WellDefined	string

ApiProperties

Nama	Jenis	Deskripsi
serverVersion	ServerVersion	Menjelaskan ServerVersion dari akun MongoDB.

BackupPolicyMigrationState

Objek yang mewakili status migrasi antara kebijakan pencadangan.

Nama	Jenis	Deskripsi
startTime	string	Waktu dimulainya migrasi kebijakan pencadangan (format ISO-8601).
status	BackupPolicyMigrationStatus	Menjelaskan status migrasi antar jenis kebijakan pencadangan.
targetType	BackupPolicyType	Menjelaskan jenis kebijakan pencadangan target dari migrasi kebijakan pencadangan.

BackupPolicyMigrationStatus

Menjelaskan status migrasi antar jenis kebijakan pencadangan.

Nama	Jenis	Deskripsi
Completed	string
Failed	string
InProgress	string
Invalid	string

BackupPolicyType

Menjelaskan mode pencadangan.

Nama	Jenis	Deskripsi
Continuous	string
Periodic	string

BackupStorageRedundancy

Enum untuk menunjukkan jenis redundansi penyimpanan cadangan.

Nama	Jenis	Deskripsi
Geo	string
Local	string
Zone	string

Capability

Objek kemampuan Cosmos DB

Nama	Jenis	Deskripsi
name	string	Nama kemampuan Cosmos DB. Misalnya, "name": "EnableCassandra". Nilai saat ini juga termasuk "EnableTable" dan "EnableGremlin".

Capacity

Objek yang mewakili semua properti yang terkait dengan penegakan kapasitas pada akun.

Nama	Jenis	Deskripsi
totalThroughputLimit	integer	Batas throughput total yang diberlakukan pada akun. TotalThroughputLimit 2000 memberlakukan batas throughput maks yang ketat yang dapat disediakan pada akun tersebut menjadi 2000. TotalThroughputLimit dari -1 menunjukkan tidak ada batasan penyediaan throughput.

ConnectorOffer

Jenis penawaran konektor cassandra untuk akun database Cosmos DB C*.

Nama	Jenis	Deskripsi
Small	string

ConsistencyPolicy

Kebijakan konsistensi untuk akun database Cosmos DB.

Nama	Jenis	Deskripsi
defaultConsistencyLevel	DefaultConsistencyLevel	Tingkat konsistensi default dan pengaturan konfigurasi akun Cosmos DB.
maxIntervalInSeconds	integer	Saat digunakan dengan tingkat konsistensi Bounded Staleness, nilai ini menunjukkan jumlah waktu kedaluarsa (dalam detik) yang ditoleransi. Rentang yang diterima untuk nilai ini adalah 5 - 86400. Diperlukan saat defaultConsistencyPolicy diatur ke 'BoundedStaleness'.
maxStalenessPrefix	integer	Saat digunakan dengan tingkat konsistensi Bounded Staleness, nilai ini menunjukkan jumlah permintaan kedaluarsa yang ditoleransi. Rentang yang diterima untuk nilai ini adalah 1 – 2.147.483.647. Diperlukan saat defaultConsistencyPolicy diatur ke 'BoundedStaleness'.

ContinuousModeBackupPolicy

Objek yang mewakili kebijakan pencadangan mode berkelanjutan.

Nama	Jenis	Deskripsi
continuousModeProperties	ContinuousModeProperties	Nilai konfigurasi untuk pencadangan mode berkelanjutan
migrationState	BackupPolicyMigrationState	Objek yang mewakili status migrasi antara kebijakan pencadangan.
type	string: Continuous	Menjelaskan mode pencadangan.

ContinuousModeProperties

Nilai konfigurasi untuk pencadangan mode berkala

Nama	Jenis	Deskripsi
tier	ContinuousTier	Enum untuk menunjukkan jenis mode pencadangan berkelanjutan

ContinuousTier

Enum untuk menunjukkan jenis tingkat pencadangan berkelanjutan.

Nama	Jenis	Deskripsi
Continuous30Days	string
Continuous7Days	string

CorsPolicy

Kebijakan CORS untuk akun database Cosmos DB.

Nama	Jenis	Deskripsi
allowedHeaders	string	Header permintaan yang dapat ditentukan domain asal pada permintaan CORS.
allowedMethods	string	Metode (kata kerja permintaan HTTP) yang dapat digunakan domain asal untuk permintaan CORS.
allowedOrigins	string	Domain asal yang diizinkan untuk membuat permintaan terhadap layanan melalui CORS.
exposedHeaders	string	Header respons yang dapat dikirim sebagai respons terhadap permintaan CORS dan diekspos oleh browser ke penerbit permintaan.
maxAgeInSeconds	integer	Waktu maksimum browser harus menyimpan cache permintaan OPTIONS preflight.

createdByType

Jenis identitas yang membuat sumber daya.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

Enum untuk menunjukkan mode pembuatan akun.

Nama	Jenis	Deskripsi
Default	string
Restore	string

DatabaseAccountCreateUpdateParameters

Parameter untuk membuat dan memperbarui akun database Cosmos DB.

Nama	Jenis	Nilai Default	Deskripsi
id	string		Pengidentifikasi sumber daya unik sumber daya ARM.
identity	ManagedServiceIdentity		Identitas untuk sumber daya.
kind	DatabaseAccountKind	GlobalDocumentDB	Menunjukkan jenis akun database. Ini hanya dapat diatur pada pembuatan akun database.
location	string		Lokasi grup sumber daya tempat sumber daya berada.
name	string		Nama sumber daya ARM.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		Properti khusus penyimpanan analitis.
properties.apiProperties	ApiProperties		Properti khusus API. Saat ini, hanya didukung untuk MongoDB API.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy		Objek yang mewakili kebijakan untuk mengambil cadangan pada akun.
properties.capabilities	Capability[]		Daftar kemampuan Cosmos DB untuk akun
properties.capacity	Capacity		Objek yang mewakili semua properti yang terkait dengan penegakan kapasitas pada akun.
properties.connectorOffer	ConnectorOffer		Jenis penawaran konektor cassandra untuk akun C* database Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy		Kebijakan konsistensi untuk akun Cosmos DB.
properties.cors	CorsPolicy[]		Kebijakan CORS untuk akun database Cosmos DB.
properties.createMode	CreateMode	Default	Enum untuk menunjukkan mode pembuatan akun.
properties.customerManagedKeyStatus	string		Menunjukkan status fitur Kunci yang Dikelola Pelanggan pada akun. Jika ada kesalahan, properti menyediakan panduan pemecahan masalah.
properties.databaseAccountOfferType	DatabaseAccountOfferType		Jenis penawaran untuk database
properties.defaultIdentity	string		Identitas default untuk mengakses brankas kunci yang digunakan dalam fitur seperti kunci yang dikelola pelanggan. Identitas default harus diatur secara eksplisit oleh pengguna. Ini bisa menjadi "FirstPartyIdentity", "SystemAssignedIdentity" dan banyak lagi.
properties.disableKeyBasedMetadataWriteAccess	boolean		Menonaktifkan operasi tulis pada sumber daya metadata (database, kontainer, throughput) melalui kunci akun
properties.disableLocalAuth	boolean		Menolak autentikasi lokal dan memastikan hanya MSI dan AAD yang dapat digunakan secara eksklusif untuk autentikasi.
properties.enableAnalyticalStorage	boolean		Bendera untuk menunjukkan apakah akan mengaktifkan analitik penyimpanan.
properties.enableAutomaticFailover	boolean		Mengaktifkan failover otomatis wilayah tulis jika wilayah tersebut tidak tersedia karena pemadaman. Failover otomatis akan menghasilkan wilayah tulis baru untuk akun dan dipilih berdasarkan prioritas failover yang dikonfigurasi untuk akun tersebut.
properties.enableBurstCapacity	boolean		Bendera untuk menunjukkan mengaktifkan/menonaktifkan fitur Pratinjau Kapasitas Burst pada akun
properties.enableCassandraConnector	boolean		Mengaktifkan konektor cassandra pada akun Cosmos DB C*
properties.enableFreeTier	boolean		Bendera untuk menunjukkan apakah Tingkat Gratis diaktifkan.
properties.enableMultipleWriteLocations	boolean		Mengaktifkan akun untuk menulis di beberapa lokasi
properties.enablePartitionMerge	boolean		Bendera untuk menunjukkan pengaktifan/penonaktifan fitur Gabungan Partisi pada akun
properties.ipRules	IpAddressOrRange[]		Daftar IpRules.
properties.isVirtualNetworkFilterEnabled	boolean		Bendera untuk menunjukkan apakah akan mengaktifkan/menonaktifkan aturan ACL Virtual Network.
properties.keyVaultKeyUri	string		URI brankas kunci
properties.keysMetadata	DatabaseAccountKeysMetadata		Properti ini diabaikan selama operasi pembaruan/pembuatan, karena metadata bersifat baca-saja. Objek mewakili metadata untuk Kunci Akun akun Cosmos DB.
properties.locations	Location[]		Array yang berisi lokasi georeplikasi yang diaktifkan untuk akun Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion		Menunjukkan versi Tls minimum yang diizinkan. Nilai defaultnya adalah Tls 1.2. API Cassandra dan Mongo hanya berfungsi dengan Tls 1.2.
properties.networkAclBypass	NetworkAclBypass		Menunjukkan layanan apa yang diizinkan untuk melewati pemeriksaan firewall.
properties.networkAclBypassResourceIds	string[]		Array yang berisi Id Sumber Daya untuk Bypass Acl Jaringan untuk akun Cosmos DB.
properties.publicNetworkAccess	PublicNetworkAccess		Apakah permintaan dari Jaringan Publik diizinkan
properties.restoreParameters	RestoreParameters		Parameter untuk menunjukkan informasi tentang pemulihan.
properties.virtualNetworkRules	VirtualNetworkRule[]		Daftar aturan ACL Virtual Network yang dikonfigurasi untuk akun Cosmos DB.
tags	object		Tag adalah daftar pasangan kunci-nilai yang menjelaskan sumber daya. Tag ini dapat digunakan dalam melihat dan mengelompokkan sumber daya ini (di seluruh grup sumber daya). Maksimal 15 tag dapat disediakan untuk sumber daya. Setiap tag harus memiliki kunci yang tidak lebih besar dari 128 karakter dan nilai tidak lebih besar dari 256 karakter. Misalnya, pengalaman default untuk jenis templat diatur dengan "defaultExperience": "Cassandra". Nilai "defaultExperience" saat ini juga mencakup "Table", "Graph", "DocumentDB", dan "MongoDB".
type	string		Jenis sumber daya Azure.

DatabaseAccountGetResults

Akun database Azure Cosmos DB.

Nama	Jenis	Nilai Default	Deskripsi
id	string		Pengidentifikasi sumber daya unik sumber daya ARM.
identity	ManagedServiceIdentity		Identitas untuk sumber daya.
kind	DatabaseAccountKind	GlobalDocumentDB	Menunjukkan jenis akun database. Ini hanya dapat diatur pada pembuatan akun database.
location	string		Lokasi grup sumber daya tempat sumber daya berada.
name	string		Nama sumber daya ARM.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		Properti khusus penyimpanan analitis.
properties.apiProperties	ApiProperties		Properti khusus API.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy		Objek yang mewakili kebijakan untuk mengambil cadangan pada akun.
properties.capabilities	Capability[]		Daftar kemampuan Cosmos DB untuk akun
properties.capacity	Capacity		Objek yang mewakili semua properti yang terkait dengan penegakan kapasitas pada akun.
properties.connectorOffer	ConnectorOffer		Jenis penawaran konektor cassandra untuk akun C* database Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy		Kebijakan konsistensi untuk akun database Cosmos DB.
properties.cors	CorsPolicy[]		Kebijakan CORS untuk akun database Cosmos DB.
properties.createMode	CreateMode	Default	Enum untuk menunjukkan mode pembuatan akun.
properties.customerManagedKeyStatus	string		Menunjukkan status fitur Kunci yang Dikelola Pelanggan pada akun. Jika ada kesalahan, properti menyediakan panduan pemecahan masalah.
properties.databaseAccountOfferType	DatabaseAccountOfferType		Jenis penawaran untuk akun database Cosmos DB. Nilai default: Standar.
properties.defaultIdentity	string		Identitas default untuk mengakses brankas kunci yang digunakan dalam fitur seperti kunci yang dikelola pelanggan. Identitas default harus diatur secara eksplisit oleh pengguna. Ini bisa menjadi "FirstPartyIdentity", "SystemAssignedIdentity" dan banyak lagi.
properties.disableKeyBasedMetadataWriteAccess	boolean		Menonaktifkan operasi tulis pada sumber daya metadata (database, kontainer, throughput) melalui kunci akun
properties.disableLocalAuth	boolean		Menolak autentikasi lokal dan memastikan hanya MSI dan AAD yang dapat digunakan secara eksklusif untuk autentikasi.
properties.documentEndpoint	string		Titik akhir koneksi untuk akun database Cosmos DB.
properties.enableAnalyticalStorage	boolean		Bendera untuk menunjukkan apakah akan mengaktifkan analitik penyimpanan.
properties.enableAutomaticFailover	boolean		Memungkinkan failover otomatis wilayah tulis dalam peristiwa langka bahwa wilayah tersebut tidak tersedia karena pemadaman. Failover otomatis akan menghasilkan wilayah tulis baru untuk akun dan dipilih berdasarkan prioritas failover yang dikonfigurasi untuk akun tersebut.
properties.enableBurstCapacity	boolean		Bendera untuk menunjukkan mengaktifkan/menonaktifkan fitur Pratinjau Kapasitas Burst pada akun
properties.enableCassandraConnector	boolean		Mengaktifkan konektor cassandra pada akun Cosmos DB C*
properties.enableFreeTier	boolean		Bendera untuk menunjukkan apakah Tingkat Gratis diaktifkan.
properties.enableMultipleWriteLocations	boolean		Mengaktifkan akun untuk menulis di beberapa lokasi
properties.enablePartitionMerge	boolean		Bendera untuk menunjukkan pengaktifan/penonaktifan fitur Gabungan Partisi pada akun
properties.failoverPolicies	FailoverPolicy[]		Array yang berisi wilayah yang diurutkan berdasarkan prioritas failover mereka.
properties.instanceId	string		Pengidentifikasi unik yang ditetapkan ke akun database
properties.ipRules	IpAddressOrRange[]		Daftar IpRules.
properties.isVirtualNetworkFilterEnabled	boolean		Bendera untuk menunjukkan apakah akan mengaktifkan/menonaktifkan aturan ACL Virtual Network.
properties.keyVaultKeyUri	string		URI brankas kunci
properties.keysMetadata	DatabaseAccountKeysMetadata		Objek yang mewakili metadata untuk Kunci Akun akun Cosmos DB.
properties.locations	Location[]		Array yang berisi semua lokasi yang diaktifkan untuk akun Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion		Menunjukkan versi Tls minimum yang diizinkan. Nilai defaultnya adalah Tls 1.2. API Cassandra dan Mongo hanya berfungsi dengan Tls 1.2.
properties.networkAclBypass	NetworkAclBypass		Menunjukkan layanan apa yang diizinkan untuk melewati pemeriksaan firewall.
properties.networkAclBypassResourceIds	string[]		Array yang berisi Id Sumber Daya untuk Bypass Acl Jaringan untuk akun Cosmos DB.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Daftar Connections Titik Akhir Privat yang dikonfigurasi untuk akun Cosmos DB.
properties.provisioningState	string		Status akun Cosmos DB pada saat operasi dipanggil. Statusnya bisa menjadi salah satu dari berikut ini. 'Membuat' – akun Cosmos DB sedang dibuat. Saat akun dalam status Membuat, hanya properti yang ditentukan sebagai input untuk operasi buat akun Cosmos DB yang dikembalikan. 'Berhasil' – akun Cosmos DB aktif untuk digunakan. 'Memperbarui' – akun Cosmos DB sedang diperbarui. 'Menghapus' – akun Cosmos DB sedang dihapus. 'Gagal' – pembuatan akun Cosmos DB gagal. 'DeletionFailed' – penghapusan akun Cosmos DB gagal.
properties.publicNetworkAccess	PublicNetworkAccess		Apakah permintaan dari Jaringan Publik diizinkan
properties.readLocations	Location[]		Array yang berisi lokasi baca yang diaktifkan untuk akun Cosmos DB.
properties.restoreParameters	RestoreParameters		Parameter untuk menunjukkan informasi tentang pemulihan.
properties.virtualNetworkRules	VirtualNetworkRule[]		Daftar aturan ACL Virtual Network yang dikonfigurasi untuk akun Cosmos DB.
properties.writeLocations	Location[]		Array yang berisi lokasi tulis untuk akun Cosmos DB.
systemData	systemData		Data meta sistem yang berkaitan dengan sumber daya ini.
tags	object		Tag adalah daftar pasangan kunci-nilai yang menjelaskan sumber daya. Tag ini dapat digunakan dalam melihat dan mengelompokkan sumber daya ini (di seluruh grup sumber daya). Maksimal 15 tag dapat disediakan untuk sumber daya. Setiap tag harus memiliki kunci yang tidak lebih besar dari 128 karakter dan nilai tidak lebih besar dari 256 karakter. Misalnya, pengalaman default untuk jenis templat diatur dengan "defaultExperience": "Cassandra". Nilai "defaultExperience" saat ini juga mencakup "Table", "Graph", "DocumentDB", dan "MongoDB".
type	string		Jenis sumber daya Azure.

DatabaseAccountKeysMetadata

Metadata yang terkait dengan setiap kunci akses untuk akun database Cosmos DB yang diberikan.

Nama	Jenis	Deskripsi
primaryMasterKey	AccountKeyMetadata	Metadata yang terkait dengan Kunci Read-Write Utama untuk akun database Cosmos DB yang diberikan.
primaryReadonlyMasterKey	AccountKeyMetadata	Metadata yang terkait dengan Kunci Read-Only Utama untuk akun database Cosmos DB yang diberikan.
secondaryMasterKey	AccountKeyMetadata	Metadata yang terkait dengan Kunci Read-Write Sekunder untuk akun database Cosmos DB yang diberikan.
secondaryReadonlyMasterKey	AccountKeyMetadata	Metadata yang terkait dengan Kunci Read-Only Sekunder untuk akun database Cosmos DB yang diberikan.

DatabaseAccountKind

Menunjukkan jenis akun database. Ini hanya dapat diatur pada pembuatan akun database.

Nama	Jenis	Deskripsi
GlobalDocumentDB	string
MongoDB	string
Parse	string

DatabaseAccountOfferType

Jenis penawaran untuk akun database Cosmos DB.

Nama	Jenis	Deskripsi
Standard	string

DatabaseRestoreResource

Database Tertentu untuk dipulihkan.

Nama	Jenis	Deskripsi
collectionNames	string[]	Nama koleksi yang tersedia untuk dipulihkan.
databaseName	string	Nama database yang tersedia untuk dipulihkan.

DefaultConsistencyLevel

Tingkat konsistensi default dan pengaturan konfigurasi akun Cosmos DB.

Nama	Jenis	Deskripsi
BoundedStaleness	string
ConsistentPrefix	string
Eventual	string
Session	string
Strong	string

FailoverPolicy

Kebijakan failover untuk wilayah tertentu dari akun database.

Nama	Jenis	Deskripsi
failoverPriority	integer	Prioritas failover wilayah. Prioritas failover 0 menunjukkan wilayah tulis. Nilai maksimum untuk prioritas failover = (jumlah total wilayah - 1). Nilai prioritas failover harus unik untuk setiap wilayah tempat akun database berada.
id	string	Pengidentifikasi unik wilayah tempat akun database direplikasi. Contoh: <accountName-locationName>><.
locationName	string	Nama wilayah tempat akun database berada.

GremlinDatabaseRestoreResource

Database Gremlin tertentu untuk dipulihkan.

Nama	Jenis	Deskripsi
databaseName	string	Nama database gremlin yang tersedia untuk dipulihkan.
graphNames	string[]	Nama grafik yang tersedia untuk dipulihkan.

IpAddressOrRange

Objek IpAddressOrRange

Nama	Jenis	Deskripsi
ipAddressOrRange	string	Satu alamat IPv4 atau satu rentang alamat IPv4 dalam format CIDR. IP yang disediakan harus diformat dengan baik dan tidak dapat dimuat dalam salah satu rentang berikut: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, karena ini tidak dapat diberlakukan oleh filter alamat IP. Contoh input yang valid: "23.40.210.245" atau "23.40.210.0/8".

Location

Wilayah tempat akun database Azure Cosmos DB disebarkan.

Nama	Jenis	Deskripsi
documentEndpoint	string	Titik akhir koneksi untuk wilayah tertentu. Contoh: https://< accountName-locationName.documents.azure.com:443/><>
failoverPriority	integer	Prioritas failover wilayah. Prioritas failover 0 menunjukkan wilayah tulis. Nilai maksimum untuk prioritas failover = (jumlah total wilayah - 1). Nilai prioritas failover harus unik untuk setiap wilayah tempat akun database berada.
id	string	Pengidentifikasi unik wilayah dalam akun database. Contoh: <accountName-locationName>><.
isZoneRedundant	boolean	Bendera untuk menunjukkan apakah wilayah ini adalah wilayah AvailabilityZone atau tidak
locationName	string	Nama wilayah.
provisioningState	string	Status akun Cosmos DB pada saat operasi dipanggil. Statusnya bisa menjadi salah satu dari berikut ini. 'Membuat' – akun Cosmos DB sedang dibuat. Saat akun dalam status Membuat, hanya properti yang ditentukan sebagai input untuk operasi buat akun Cosmos DB yang dikembalikan. 'Berhasil' – akun Cosmos DB aktif untuk digunakan. 'Memperbarui' – akun Cosmos DB sedang diperbarui. 'Menghapus' – akun Cosmos DB sedang dihapus. 'Gagal' – pembuatan akun Cosmos DB gagal. 'DeletionFailed' – penghapusan akun Cosmos DB gagal.

ManagedServiceIdentity

Identitas untuk sumber daya.

Nama	Jenis	Deskripsi
principalId	string	Id utama dari identitas yang ditetapkan sistem. Properti ini hanya akan disediakan untuk identitas yang ditetapkan sistem.
tenantId	string	Id penyewa dari identitas yang ditetapkan sistem. Properti ini hanya akan disediakan untuk identitas yang ditetapkan sistem.
type	ResourceIdentityType	Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned,UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun dari layanan.
userAssignedIdentities	UserAssignedIdentities	Daftar identitas pengguna yang terkait dengan sumber daya. Referensi kunci kamus identitas pengguna akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

MinimalTlsVersion

Menunjukkan versi Tls minimum yang diizinkan. Nilai defaultnya adalah Tls 1.2. API Cassandra dan Mongo hanya berfungsi dengan Tls 1.2.

Nama	Jenis	Deskripsi
Tls	string
Tls11	string
Tls12	string

NetworkAclBypass

Menunjukkan layanan apa yang diizinkan untuk melewati pemeriksaan firewall.

Nama	Jenis	Deskripsi
AzureServices	string
None	string

PeriodicModeBackupPolicy

Objek yang mewakili kebijakan pencadangan mode berkala.

Nama	Jenis	Deskripsi
migrationState	BackupPolicyMigrationState	Objek yang mewakili status migrasi antara kebijakan pencadangan.
periodicModeProperties	PeriodicModeProperties	Nilai konfigurasi untuk pencadangan mode berkala
type	string: Periodic	Menjelaskan mode pencadangan.

PeriodicModeProperties

Nilai konfigurasi untuk pencadangan mode berkala

Nama	Jenis	Deskripsi
backupIntervalInMinutes	integer	Bilangan bulat yang mewakili interval dalam hitungan menit di antara dua cadangan
backupRetentionIntervalInHours	integer	Bilangan bulat yang mewakili waktu (dalam jam) bahwa setiap cadangan dipertahankan
backupStorageRedundancy	BackupStorageRedundancy	Enum untuk menunjukkan jenis residensi cadangan

PrivateEndpointConnection

Koneksi titik akhir privat

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya.
properties.groupId	string	Id grup titik akhir privat.
properties.privateEndpoint	PrivateEndpointProperty	Titik akhir privat tempat koneksi berada.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Status Koneksi Koneksi Titik Akhir Privat.
properties.provisioningState	string	Status provisi titik akhir privat.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

Titik akhir privat tempat koneksi berada.

Nama	Jenis	Deskripsi
id	string	Id sumber daya titik akhir privat.

PrivateLinkServiceConnectionStateProperty

Status Koneksi Koneksi Titik Akhir Privat.

Nama	Jenis	Deskripsi
actionsRequired	string	Tindakan apa pun yang diperlukan di luar alur kerja dasar (setujui/tolak/putuskan sambungan)
description	string	Deskripsi koneksi layanan tautan privat.
status	string	Status koneksi layanan tautan privat.

PublicNetworkAccess

Apakah permintaan dari Jaringan Publik diizinkan

Nama	Jenis	Deskripsi
Disabled	string
Enabled	string
SecuredByPerimeter	string

ResourceIdentityType

Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned,UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun dari layanan.

Nama	Jenis	Deskripsi
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

RestoreMode

Menjelaskan mode pemulihan.

Nama	Jenis	Deskripsi
PointInTime	string

RestoreParameters

Parameter untuk menunjukkan informasi tentang pemulihan.

Nama	Jenis	Deskripsi
databasesToRestore	DatabaseRestoreResource[]	Daftar database tertentu yang tersedia untuk dipulihkan.
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	Daftar database gremlin tertentu yang tersedia untuk dipulihkan.
restoreMode	RestoreMode	Menjelaskan mode pemulihan.
restoreSource	string	Id akun database yang dapat dipulihkan dari mana pemulihan harus dimulai. Misalnya: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	Waktu di mana akun harus dipulihkan (format ISO-8601).
tablesToRestore	string[]	Daftar tabel tertentu yang tersedia untuk dipulihkan.

ServerVersion

Menjelaskan ServerVersion dari akun MongoDB.

Nama	Jenis	Deskripsi
3.2	string
3.6	string
4.0	string
4.2	string

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir mengubah sumber daya.

UserAssignedIdentities

Daftar identitas pengguna yang terkait dengan sumber daya. Referensi kunci kamus identitas pengguna akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Nama	Jenis	Deskripsi

VirtualNetworkRule

Virtual Network objek Aturan ACL

Nama	Jenis	Deskripsi
id	string	ID sumber daya subnet, misalnya: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignoreMissingVNetServiceEndpoint	boolean	Buat aturan firewall sebelum jaringan virtual mengaktifkan titik akhir layanan vnet.