Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. cosmosdb
  5. DatabaseAccount
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.cosmosdb.DatabaseAccount

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

An Azure Cosmos DB database account.

Uses Azure REST API version 2024-11-15.

Other available API versions: 2015-04-01, 2015-04-08, 2015-11-06, 2016-03-19, 2016-03-31, 2019-08-01, 2019-12-12, 2020-03-01, 2020-04-01, 2020-06-01-preview, 2020-09-01, 2021-01-15, 2021-03-01-preview, 2021-03-15, 2021-04-01-preview, 2021-04-15, 2021-05-15, 2021-06-15, 2021-07-01-preview, 2021-10-15, 2021-10-15-preview, 2021-11-15-preview, 2022-02-15-preview, 2022-05-15, 2022-05-15-preview, 2022-08-15, 2022-08-15-preview, 2022-11-15, 2022-11-15-preview, 2023-03-01-preview, 2023-03-15, 2023-03-15-preview, 2023-04-15, 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15, 2024-05-15-preview, 2024-08-15, 2024-09-01-preview, 2024-12-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cosmosdb [ApiVersion]. See the version guide for details.

Example Usage

CosmosDBDatabaseAccountCreateMin

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var databaseAccount = new AzureNative.CosmosDB.DatabaseAccount("databaseAccount", new()
    {
        AccountName = "ddb1",
        CreateMode = AzureNative.CosmosDB.CreateMode.Default,
        DatabaseAccountOfferType = AzureNative.CosmosDB.DatabaseAccountOfferType.Standard,
        Location = "westus",
        Locations = new[]
        {
            new AzureNative.CosmosDB.Inputs.LocationArgs
            {
                FailoverPriority = 0,
                IsZoneRedundant = false,
                LocationName = "southcentralus",
            },
        },
        ResourceGroupName = "rg1",
    });

});
Copy
package main

import (
	cosmosdb "github.com/pulumi/pulumi-azure-native-sdk/cosmosdb/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cosmosdb.NewDatabaseAccount(ctx, "databaseAccount", &cosmosdb.DatabaseAccountArgs{
			AccountName:              pulumi.String("ddb1"),
			CreateMode:               pulumi.String(cosmosdb.CreateModeDefault),
			DatabaseAccountOfferType: cosmosdb.DatabaseAccountOfferTypeStandard,
			Location:                 pulumi.String("westus"),
			Locations: cosmosdb.LocationArray{
				&cosmosdb.LocationArgs{
					FailoverPriority: pulumi.Int(0),
					IsZoneRedundant:  pulumi.Bool(false),
					LocationName:     pulumi.String("southcentralus"),
				},
			},
			ResourceGroupName: pulumi.String("rg1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.cosmosdb.DatabaseAccount;
import com.pulumi.azurenative.cosmosdb.DatabaseAccountArgs;
import com.pulumi.azurenative.cosmosdb.inputs.LocationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var databaseAccount = new DatabaseAccount("databaseAccount", DatabaseAccountArgs.builder()
            .accountName("ddb1")
            .createMode("Default")
            .databaseAccountOfferType("Standard")
            .location("westus")
            .locations(LocationArgs.builder()
                .failoverPriority(0)
                .isZoneRedundant(false)
                .locationName("southcentralus")
                .build())
            .resourceGroupName("rg1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const databaseAccount = new azure_native.cosmosdb.DatabaseAccount("databaseAccount", {
    accountName: "ddb1",
    createMode: azure_native.cosmosdb.CreateMode.Default,
    databaseAccountOfferType: azure_native.cosmosdb.DatabaseAccountOfferType.Standard,
    location: "westus",
    locations: [{
        failoverPriority: 0,
        isZoneRedundant: false,
        locationName: "southcentralus",
    }],
    resourceGroupName: "rg1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

database_account = azure_native.cosmosdb.DatabaseAccount("databaseAccount",
    account_name="ddb1",
    create_mode=azure_native.cosmosdb.CreateMode.DEFAULT,
    database_account_offer_type=azure_native.cosmosdb.DatabaseAccountOfferType.STANDARD,
    location="westus",
    locations=[{
        "failover_priority": 0,
        "is_zone_redundant": False,
        "location_name": "southcentralus",
    }],
    resource_group_name="rg1")
Copy
resources:
  databaseAccount:
    type: azure-native:cosmosdb:DatabaseAccount
    properties:
      accountName: ddb1
      createMode: Default
      databaseAccountOfferType: Standard
      location: westus
      locations:
        - failoverPriority: 0
          isZoneRedundant: false
          locationName: southcentralus
      resourceGroupName: rg1
Copy

CosmosDBRestoreDatabaseAccountCreateUpdate.json

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var databaseAccount = new AzureNative.CosmosDB.DatabaseAccount("databaseAccount", new()
    {
        AccountName = "ddb1",
        ApiProperties = new AzureNative.CosmosDB.Inputs.ApiPropertiesArgs
        {
            ServerVersion = AzureNative.CosmosDB.ServerVersion.ServerVersion_3_2,
        },
        BackupPolicy = new AzureNative.CosmosDB.Inputs.ContinuousModeBackupPolicyArgs
        {
            ContinuousModeProperties = new AzureNative.CosmosDB.Inputs.ContinuousModePropertiesArgs
            {
                Tier = AzureNative.CosmosDB.ContinuousTier.Continuous30Days,
            },
            Type = "Continuous",
        },
        ConsistencyPolicy = new AzureNative.CosmosDB.Inputs.ConsistencyPolicyArgs
        {
            DefaultConsistencyLevel = AzureNative.CosmosDB.DefaultConsistencyLevel.BoundedStaleness,
            MaxIntervalInSeconds = 10,
            MaxStalenessPrefix = 200,
        },
        CreateMode = AzureNative.CosmosDB.CreateMode.Restore,
        DatabaseAccountOfferType = AzureNative.CosmosDB.DatabaseAccountOfferType.Standard,
        EnableAnalyticalStorage = true,
        EnableFreeTier = false,
        KeyVaultKeyUri = "https://myKeyVault.vault.azure.net",
        Kind = AzureNative.CosmosDB.DatabaseAccountKind.GlobalDocumentDB,
        Location = "westus",
        Locations = new[]
        {
            new AzureNative.CosmosDB.Inputs.LocationArgs
            {
                FailoverPriority = 0,
                IsZoneRedundant = false,
                LocationName = "southcentralus",
            },
        },
        MinimalTlsVersion = AzureNative.CosmosDB.MinimalTlsVersion.Tls,
        ResourceGroupName = "rg1",
        RestoreParameters = new AzureNative.CosmosDB.Inputs.RestoreParametersArgs
        {
            DatabasesToRestore = new[]
            {
                new AzureNative.CosmosDB.Inputs.DatabaseRestoreResourceArgs
                {
                    CollectionNames = new[]
                    {
                        "collection1",
                        "collection2",
                    },
                    DatabaseName = "db1",
                },
                new AzureNative.CosmosDB.Inputs.DatabaseRestoreResourceArgs
                {
                    CollectionNames = new[]
                    {
                        "collection3",
                        "collection4",
                    },
                    DatabaseName = "db2",
                },
            },
            RestoreMode = AzureNative.CosmosDB.RestoreMode.PointInTime,
            RestoreSource = "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/1a97b4bb-f6a0-430e-ade1-638d781830cc",
            RestoreTimestampInUtc = "2021-03-11T22:05:09Z",
            RestoreWithTtlDisabled = false,
        },
        Tags = null,
    });

});
Copy
package main

import (
	cosmosdb "github.com/pulumi/pulumi-azure-native-sdk/cosmosdb/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cosmosdb.NewDatabaseAccount(ctx, "databaseAccount", &cosmosdb.DatabaseAccountArgs{
			AccountName: pulumi.String("ddb1"),
			ApiProperties: &cosmosdb.ApiPropertiesArgs{
				ServerVersion: pulumi.String(cosmosdb.ServerVersion_3_2),
			},
			BackupPolicy: &cosmosdb.ContinuousModeBackupPolicyArgs{
				ContinuousModeProperties: &cosmosdb.ContinuousModePropertiesArgs{
					Tier: pulumi.String(cosmosdb.ContinuousTierContinuous30Days),
				},
				Type: pulumi.String("Continuous"),
			},
			ConsistencyPolicy: &cosmosdb.ConsistencyPolicyArgs{
				DefaultConsistencyLevel: cosmosdb.DefaultConsistencyLevelBoundedStaleness,
				MaxIntervalInSeconds:    pulumi.Int(10),
				MaxStalenessPrefix:      pulumi.Float64(200),
			},
			CreateMode:               pulumi.String(cosmosdb.CreateModeRestore),
			DatabaseAccountOfferType: cosmosdb.DatabaseAccountOfferTypeStandard,
			EnableAnalyticalStorage:  pulumi.Bool(true),
			EnableFreeTier:           pulumi.Bool(false),
			KeyVaultKeyUri:           pulumi.String("https://myKeyVault.vault.azure.net"),
			Kind:                     pulumi.String(cosmosdb.DatabaseAccountKindGlobalDocumentDB),
			Location:                 pulumi.String("westus"),
			Locations: cosmosdb.LocationArray{
				&cosmosdb.LocationArgs{
					FailoverPriority: pulumi.Int(0),
					IsZoneRedundant:  pulumi.Bool(false),
					LocationName:     pulumi.String("southcentralus"),
				},
			},
			MinimalTlsVersion: pulumi.String(cosmosdb.MinimalTlsVersionTls),
			ResourceGroupName: pulumi.String("rg1"),
			RestoreParameters: &cosmosdb.RestoreParametersArgs{
				DatabasesToRestore: cosmosdb.DatabaseRestoreResourceArray{
					&cosmosdb.DatabaseRestoreResourceArgs{
						CollectionNames: pulumi.StringArray{
							pulumi.String("collection1"),
							pulumi.String("collection2"),
						},
						DatabaseName: pulumi.String("db1"),
					},
					&cosmosdb.DatabaseRestoreResourceArgs{
						CollectionNames: pulumi.StringArray{
							pulumi.String("collection3"),
							pulumi.String("collection4"),
						},
						DatabaseName: pulumi.String("db2"),
					},
				},
				RestoreMode:            pulumi.String(cosmosdb.RestoreModePointInTime),
				RestoreSource:          pulumi.String("/subscriptions/subid/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/1a97b4bb-f6a0-430e-ade1-638d781830cc"),
				RestoreTimestampInUtc:  pulumi.String("2021-03-11T22:05:09Z"),
				RestoreWithTtlDisabled: pulumi.Bool(false),
			},
			Tags: pulumi.StringMap{},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.cosmosdb.DatabaseAccount;
import com.pulumi.azurenative.cosmosdb.DatabaseAccountArgs;
import com.pulumi.azurenative.cosmosdb.inputs.ApiPropertiesArgs;
import com.pulumi.azurenative.cosmosdb.inputs.ConsistencyPolicyArgs;
import com.pulumi.azurenative.cosmosdb.inputs.LocationArgs;
import com.pulumi.azurenative.cosmosdb.inputs.RestoreParametersArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var databaseAccount = new DatabaseAccount("databaseAccount", DatabaseAccountArgs.builder()
            .accountName("ddb1")
            .apiProperties(ApiPropertiesArgs.builder()
                .serverVersion("3.2")
                .build())
            .backupPolicy(ContinuousModeBackupPolicyArgs.builder()
                .continuousModeProperties(ContinuousModePropertiesArgs.builder()
                    .tier("Continuous30Days")
                    .build())
                .type("Continuous")
                .build())
            .consistencyPolicy(ConsistencyPolicyArgs.builder()
                .defaultConsistencyLevel("BoundedStaleness")
                .maxIntervalInSeconds(10)
                .maxStalenessPrefix(200.0)
                .build())
            .createMode("Restore")
            .databaseAccountOfferType("Standard")
            .enableAnalyticalStorage(true)
            .enableFreeTier(false)
            .keyVaultKeyUri("https://myKeyVault.vault.azure.net")
            .kind("GlobalDocumentDB")
            .location("westus")
            .locations(LocationArgs.builder()
                .failoverPriority(0)
                .isZoneRedundant(false)
                .locationName("southcentralus")
                .build())
            .minimalTlsVersion("Tls")
            .resourceGroupName("rg1")
            .restoreParameters(RestoreParametersArgs.builder()
                .databasesToRestore(                
                    DatabaseRestoreResourceArgs.builder()
                        .collectionNames(                        
                            "collection1",
                            "collection2")
                        .databaseName("db1")
                        .build(),
                    DatabaseRestoreResourceArgs.builder()
                        .collectionNames(                        
                            "collection3",
                            "collection4")
                        .databaseName("db2")
                        .build())
                .restoreMode("PointInTime")
                .restoreSource("/subscriptions/subid/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/1a97b4bb-f6a0-430e-ade1-638d781830cc")
                .restoreTimestampInUtc("2021-03-11T22:05:09Z")
                .restoreWithTtlDisabled(false)
                .build())
            .tags(Map.ofEntries(
            ))
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const databaseAccount = new azure_native.cosmosdb.DatabaseAccount("databaseAccount", {
    accountName: "ddb1",
    apiProperties: {
        serverVersion: azure_native.cosmosdb.ServerVersion.ServerVersion_3_2,
    },
    backupPolicy: {
        continuousModeProperties: {
            tier: azure_native.cosmosdb.ContinuousTier.Continuous30Days,
        },
        type: "Continuous",
    },
    consistencyPolicy: {
        defaultConsistencyLevel: azure_native.cosmosdb.DefaultConsistencyLevel.BoundedStaleness,
        maxIntervalInSeconds: 10,
        maxStalenessPrefix: 200,
    },
    createMode: azure_native.cosmosdb.CreateMode.Restore,
    databaseAccountOfferType: azure_native.cosmosdb.DatabaseAccountOfferType.Standard,
    enableAnalyticalStorage: true,
    enableFreeTier: false,
    keyVaultKeyUri: "https://myKeyVault.vault.azure.net",
    kind: azure_native.cosmosdb.DatabaseAccountKind.GlobalDocumentDB,
    location: "westus",
    locations: [{
        failoverPriority: 0,
        isZoneRedundant: false,
        locationName: "southcentralus",
    }],
    minimalTlsVersion: azure_native.cosmosdb.MinimalTlsVersion.Tls,
    resourceGroupName: "rg1",
    restoreParameters: {
        databasesToRestore: [
            {
                collectionNames: [
                    "collection1",
                    "collection2",
                ],
                databaseName: "db1",
            },
            {
                collectionNames: [
                    "collection3",
                    "collection4",
                ],
                databaseName: "db2",
            },
        ],
        restoreMode: azure_native.cosmosdb.RestoreMode.PointInTime,
        restoreSource: "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/1a97b4bb-f6a0-430e-ade1-638d781830cc",
        restoreTimestampInUtc: "2021-03-11T22:05:09Z",
        restoreWithTtlDisabled: false,
    },
    tags: {},
});
Copy
import pulumi
import pulumi_azure_native as azure_native

database_account = azure_native.cosmosdb.DatabaseAccount("databaseAccount",
    account_name="ddb1",
    api_properties={
        "server_version": azure_native.cosmosdb.ServerVersion.SERVER_VERSION_3_2,
    },
    backup_policy={
        "continuous_mode_properties": {
            "tier": azure_native.cosmosdb.ContinuousTier.CONTINUOUS30_DAYS,
        },
        "type": "Continuous",
    },
    consistency_policy={
        "default_consistency_level": azure_native.cosmosdb.DefaultConsistencyLevel.BOUNDED_STALENESS,
        "max_interval_in_seconds": 10,
        "max_staleness_prefix": 200,
    },
    create_mode=azure_native.cosmosdb.CreateMode.RESTORE,
    database_account_offer_type=azure_native.cosmosdb.DatabaseAccountOfferType.STANDARD,
    enable_analytical_storage=True,
    enable_free_tier=False,
    key_vault_key_uri="https://myKeyVault.vault.azure.net",
    kind=azure_native.cosmosdb.DatabaseAccountKind.GLOBAL_DOCUMENT_DB,
    location="westus",
    locations=[{
        "failover_priority": 0,
        "is_zone_redundant": False,
        "location_name": "southcentralus",
    }],
    minimal_tls_version=azure_native.cosmosdb.MinimalTlsVersion.TLS,
    resource_group_name="rg1",
    restore_parameters={
        "databases_to_restore": [
            {
                "collection_names": [
                    "collection1",
                    "collection2",
                ],
                "database_name": "db1",
            },
            {
                "collection_names": [
                    "collection3",
                    "collection4",
                ],
                "database_name": "db2",
            },
        ],
        "restore_mode": azure_native.cosmosdb.RestoreMode.POINT_IN_TIME,
        "restore_source": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/1a97b4bb-f6a0-430e-ade1-638d781830cc",
        "restore_timestamp_in_utc": "2021-03-11T22:05:09Z",
        "restore_with_ttl_disabled": False,
    },
    tags={})
Copy
resources:
  databaseAccount:
    type: azure-native:cosmosdb:DatabaseAccount
    properties:
      accountName: ddb1
      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
      kind: GlobalDocumentDB
      location: westus
      locations:
        - failoverPriority: 0
          isZoneRedundant: false
          locationName: southcentralus
      minimalTlsVersion: Tls
      resourceGroupName: rg1
      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
        restoreWithTtlDisabled: false
      tags: {}
Copy

Create DatabaseAccount Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DatabaseAccount(name: string, args: DatabaseAccountArgs, opts?: CustomResourceOptions);
@overload
def DatabaseAccount(resource_name: str,
                    args: DatabaseAccountArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def DatabaseAccount(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    database_account_offer_type: Optional[DatabaseAccountOfferType] = None,
                    resource_group_name: Optional[str] = None,
                    locations: Optional[Sequence[LocationArgs]] = None,
                    enable_cassandra_connector: Optional[bool] = None,
                    enable_multiple_write_locations: Optional[bool] = None,
                    capacity: Optional[CapacityArgs] = None,
                    connector_offer: Optional[Union[str, ConnectorOffer]] = None,
                    consistency_policy: Optional[ConsistencyPolicyArgs] = None,
                    cors: Optional[Sequence[CorsPolicyArgs]] = None,
                    create_mode: Optional[Union[str, CreateMode]] = None,
                    customer_managed_key_status: Optional[str] = None,
                    backup_policy: Optional[Union[ContinuousModeBackupPolicyArgs, PeriodicModeBackupPolicyArgs]] = None,
                    default_identity: Optional[str] = None,
                    disable_key_based_metadata_write_access: Optional[bool] = None,
                    disable_local_auth: Optional[bool] = None,
                    enable_analytical_storage: Optional[bool] = None,
                    enable_automatic_failover: Optional[bool] = None,
                    enable_burst_capacity: Optional[bool] = None,
                    account_name: Optional[str] = None,
                    capabilities: Optional[Sequence[CapabilityArgs]] = None,
                    enable_free_tier: Optional[bool] = None,
                    enable_partition_merge: Optional[bool] = None,
                    enable_per_region_per_partition_autoscale: Optional[bool] = None,
                    identity: Optional[ManagedServiceIdentityArgs] = None,
                    ip_rules: Optional[Sequence[IpAddressOrRangeArgs]] = None,
                    is_virtual_network_filter_enabled: Optional[bool] = None,
                    key_vault_key_uri: Optional[str] = None,
                    kind: Optional[Union[str, DatabaseAccountKind]] = None,
                    location: Optional[str] = None,
                    api_properties: Optional[ApiPropertiesArgs] = None,
                    minimal_tls_version: Optional[Union[str, MinimalTlsVersion]] = None,
                    network_acl_bypass: Optional[NetworkAclBypass] = None,
                    network_acl_bypass_resource_ids: Optional[Sequence[str]] = None,
                    public_network_access: Optional[Union[str, PublicNetworkAccess]] = None,
                    analytical_storage_configuration: Optional[AnalyticalStorageConfigurationArgs] = None,
                    restore_parameters: Optional[RestoreParametersArgs] = None,
                    tags: Optional[Mapping[str, str]] = None,
                    virtual_network_rules: Optional[Sequence[VirtualNetworkRuleArgs]] = None)
func NewDatabaseAccount(ctx *Context, name string, args DatabaseAccountArgs, opts ...ResourceOption) (*DatabaseAccount, error)
public DatabaseAccount(string name, DatabaseAccountArgs args, CustomResourceOptions? opts = null)
public DatabaseAccount(String name, DatabaseAccountArgs args)
public DatabaseAccount(String name, DatabaseAccountArgs args, CustomResourceOptions options)

type: azure-native:cosmosdb:DatabaseAccount
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DatabaseAccountArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DatabaseAccountArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DatabaseAccountArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DatabaseAccountArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DatabaseAccountArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var databaseAccountResource = new AzureNative.CosmosDB.DatabaseAccount("databaseAccountResource", new()
{
    DatabaseAccountOfferType = AzureNative.CosmosDB.DatabaseAccountOfferType.Standard,
    ResourceGroupName = "string",
    Locations = new[]
    {
        new AzureNative.CosmosDB.Inputs.LocationArgs
        {
            FailoverPriority = 0,
            IsZoneRedundant = false,
            LocationName = "string",
        },
    },
    EnableCassandraConnector = false,
    EnableMultipleWriteLocations = false,
    Capacity = new AzureNative.CosmosDB.Inputs.CapacityArgs
    {
        TotalThroughputLimit = 0,
    },
    ConnectorOffer = "string",
    ConsistencyPolicy = new AzureNative.CosmosDB.Inputs.ConsistencyPolicyArgs
    {
        DefaultConsistencyLevel = AzureNative.CosmosDB.DefaultConsistencyLevel.Eventual,
        MaxIntervalInSeconds = 0,
        MaxStalenessPrefix = 0,
    },
    Cors = new[]
    {
        new AzureNative.CosmosDB.Inputs.CorsPolicyArgs
        {
            AllowedOrigins = "string",
            AllowedHeaders = "string",
            AllowedMethods = "string",
            ExposedHeaders = "string",
            MaxAgeInSeconds = 0,
        },
    },
    CreateMode = "string",
    CustomerManagedKeyStatus = "string",
    BackupPolicy = new AzureNative.CosmosDB.Inputs.ContinuousModeBackupPolicyArgs
    {
        Type = "Continuous",
        ContinuousModeProperties = new AzureNative.CosmosDB.Inputs.ContinuousModePropertiesArgs
        {
            Tier = "string",
        },
        MigrationState = new AzureNative.CosmosDB.Inputs.BackupPolicyMigrationStateArgs
        {
            StartTime = "string",
            Status = "string",
            TargetType = "string",
        },
    },
    DefaultIdentity = "string",
    DisableKeyBasedMetadataWriteAccess = false,
    DisableLocalAuth = false,
    EnableAnalyticalStorage = false,
    EnableAutomaticFailover = false,
    EnableBurstCapacity = false,
    AccountName = "string",
    Capabilities = new[]
    {
        new AzureNative.CosmosDB.Inputs.CapabilityArgs
        {
            Name = "string",
        },
    },
    EnableFreeTier = false,
    EnablePartitionMerge = false,
    EnablePerRegionPerPartitionAutoscale = false,
    Identity = new AzureNative.CosmosDB.Inputs.ManagedServiceIdentityArgs
    {
        Type = AzureNative.CosmosDB.ResourceIdentityType.SystemAssigned,
        UserAssignedIdentities = new[]
        {
            "string",
        },
    },
    IpRules = new[]
    {
        new AzureNative.CosmosDB.Inputs.IpAddressOrRangeArgs
        {
            IpAddressOrRange = "string",
        },
    },
    IsVirtualNetworkFilterEnabled = false,
    KeyVaultKeyUri = "string",
    Kind = "string",
    Location = "string",
    ApiProperties = new AzureNative.CosmosDB.Inputs.ApiPropertiesArgs
    {
        ServerVersion = "string",
    },
    MinimalTlsVersion = "string",
    NetworkAclBypass = AzureNative.CosmosDB.NetworkAclBypass.None,
    NetworkAclBypassResourceIds = new[]
    {
        "string",
    },
    PublicNetworkAccess = "string",
    AnalyticalStorageConfiguration = new AzureNative.CosmosDB.Inputs.AnalyticalStorageConfigurationArgs
    {
        SchemaType = "string",
    },
    RestoreParameters = new AzureNative.CosmosDB.Inputs.RestoreParametersArgs
    {
        DatabasesToRestore = new[]
        {
            new AzureNative.CosmosDB.Inputs.DatabaseRestoreResourceArgs
            {
                CollectionNames = new[]
                {
                    "string",
                },
                DatabaseName = "string",
            },
        },
        GremlinDatabasesToRestore = new[]
        {
            new AzureNative.CosmosDB.Inputs.GremlinDatabaseRestoreResourceArgs
            {
                DatabaseName = "string",
                GraphNames = new[]
                {
                    "string",
                },
            },
        },
        RestoreMode = "string",
        RestoreSource = "string",
        RestoreTimestampInUtc = "string",
        RestoreWithTtlDisabled = false,
        TablesToRestore = new[]
        {
            "string",
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
    VirtualNetworkRules = new[]
    {
        new AzureNative.CosmosDB.Inputs.VirtualNetworkRuleArgs
        {
            Id = "string",
            IgnoreMissingVNetServiceEndpoint = false,
        },
    },
});
Copy
example, err := cosmosdb.NewDatabaseAccount(ctx, "databaseAccountResource", &cosmosdb.DatabaseAccountArgs{
	DatabaseAccountOfferType: cosmosdb.DatabaseAccountOfferTypeStandard,
	ResourceGroupName:        pulumi.String("string"),
	Locations: cosmosdb.LocationArray{
		&cosmosdb.LocationArgs{
			FailoverPriority: pulumi.Int(0),
			IsZoneRedundant:  pulumi.Bool(false),
			LocationName:     pulumi.String("string"),
		},
	},
	EnableCassandraConnector:     pulumi.Bool(false),
	EnableMultipleWriteLocations: pulumi.Bool(false),
	Capacity: &cosmosdb.CapacityArgs{
		TotalThroughputLimit: pulumi.Int(0),
	},
	ConnectorOffer: pulumi.String("string"),
	ConsistencyPolicy: &cosmosdb.ConsistencyPolicyArgs{
		DefaultConsistencyLevel: cosmosdb.DefaultConsistencyLevelEventual,
		MaxIntervalInSeconds:    pulumi.Int(0),
		MaxStalenessPrefix:      pulumi.Float64(0),
	},
	Cors: cosmosdb.CorsPolicyArray{
		&cosmosdb.CorsPolicyArgs{
			AllowedOrigins:  pulumi.String("string"),
			AllowedHeaders:  pulumi.String("string"),
			AllowedMethods:  pulumi.String("string"),
			ExposedHeaders:  pulumi.String("string"),
			MaxAgeInSeconds: pulumi.Float64(0),
		},
	},
	CreateMode:               pulumi.String("string"),
	CustomerManagedKeyStatus: pulumi.String("string"),
	BackupPolicy: &cosmosdb.ContinuousModeBackupPolicyArgs{
		Type: pulumi.String("Continuous"),
		ContinuousModeProperties: &cosmosdb.ContinuousModePropertiesArgs{
			Tier: pulumi.String("string"),
		},
		MigrationState: &cosmosdb.BackupPolicyMigrationStateArgs{
			StartTime:  pulumi.String("string"),
			Status:     pulumi.String("string"),
			TargetType: pulumi.String("string"),
		},
	},
	DefaultIdentity:                    pulumi.String("string"),
	DisableKeyBasedMetadataWriteAccess: pulumi.Bool(false),
	DisableLocalAuth:                   pulumi.Bool(false),
	EnableAnalyticalStorage:            pulumi.Bool(false),
	EnableAutomaticFailover:            pulumi.Bool(false),
	EnableBurstCapacity:                pulumi.Bool(false),
	AccountName:                        pulumi.String("string"),
	Capabilities: cosmosdb.CapabilityArray{
		&cosmosdb.CapabilityArgs{
			Name: pulumi.String("string"),
		},
	},
	EnableFreeTier:                       pulumi.Bool(false),
	EnablePartitionMerge:                 pulumi.Bool(false),
	EnablePerRegionPerPartitionAutoscale: pulumi.Bool(false),
	Identity: &cosmosdb.ManagedServiceIdentityArgs{
		Type: cosmosdb.ResourceIdentityTypeSystemAssigned,
		UserAssignedIdentities: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	IpRules: cosmosdb.IpAddressOrRangeArray{
		&cosmosdb.IpAddressOrRangeArgs{
			IpAddressOrRange: pulumi.String("string"),
		},
	},
	IsVirtualNetworkFilterEnabled: pulumi.Bool(false),
	KeyVaultKeyUri:                pulumi.String("string"),
	Kind:                          pulumi.String("string"),
	Location:                      pulumi.String("string"),
	ApiProperties: &cosmosdb.ApiPropertiesArgs{
		ServerVersion: pulumi.String("string"),
	},
	MinimalTlsVersion: pulumi.String("string"),
	NetworkAclBypass:  cosmosdb.NetworkAclBypassNone,
	NetworkAclBypassResourceIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	PublicNetworkAccess: pulumi.String("string"),
	AnalyticalStorageConfiguration: &cosmosdb.AnalyticalStorageConfigurationArgs{
		SchemaType: pulumi.String("string"),
	},
	RestoreParameters: &cosmosdb.RestoreParametersArgs{
		DatabasesToRestore: cosmosdb.DatabaseRestoreResourceArray{
			&cosmosdb.DatabaseRestoreResourceArgs{
				CollectionNames: pulumi.StringArray{
					pulumi.String("string"),
				},
				DatabaseName: pulumi.String("string"),
			},
		},
		GremlinDatabasesToRestore: cosmosdb.GremlinDatabaseRestoreResourceArray{
			&cosmosdb.GremlinDatabaseRestoreResourceArgs{
				DatabaseName: pulumi.String("string"),
				GraphNames: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
		RestoreMode:            pulumi.String("string"),
		RestoreSource:          pulumi.String("string"),
		RestoreTimestampInUtc:  pulumi.String("string"),
		RestoreWithTtlDisabled: pulumi.Bool(false),
		TablesToRestore: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VirtualNetworkRules: cosmosdb.VirtualNetworkRuleArray{
		&cosmosdb.VirtualNetworkRuleArgs{
			Id:                               pulumi.String("string"),
			IgnoreMissingVNetServiceEndpoint: pulumi.Bool(false),
		},
	},
})
Copy
var databaseAccountResource = new DatabaseAccount("databaseAccountResource", DatabaseAccountArgs.builder()
    .databaseAccountOfferType("Standard")
    .resourceGroupName("string")
    .locations(LocationArgs.builder()
        .failoverPriority(0)
        .isZoneRedundant(false)
        .locationName("string")
        .build())
    .enableCassandraConnector(false)
    .enableMultipleWriteLocations(false)
    .capacity(CapacityArgs.builder()
        .totalThroughputLimit(0)
        .build())
    .connectorOffer("string")
    .consistencyPolicy(ConsistencyPolicyArgs.builder()
        .defaultConsistencyLevel("Eventual")
        .maxIntervalInSeconds(0)
        .maxStalenessPrefix(0)
        .build())
    .cors(CorsPolicyArgs.builder()
        .allowedOrigins("string")
        .allowedHeaders("string")
        .allowedMethods("string")
        .exposedHeaders("string")
        .maxAgeInSeconds(0)
        .build())
    .createMode("string")
    .customerManagedKeyStatus("string")
    .backupPolicy(ContinuousModeBackupPolicyArgs.builder()
        .type("Continuous")
        .continuousModeProperties(ContinuousModePropertiesArgs.builder()
            .tier("string")
            .build())
        .migrationState(BackupPolicyMigrationStateArgs.builder()
            .startTime("string")
            .status("string")
            .targetType("string")
            .build())
        .build())
    .defaultIdentity("string")
    .disableKeyBasedMetadataWriteAccess(false)
    .disableLocalAuth(false)
    .enableAnalyticalStorage(false)
    .enableAutomaticFailover(false)
    .enableBurstCapacity(false)
    .accountName("string")
    .capabilities(CapabilityArgs.builder()
        .name("string")
        .build())
    .enableFreeTier(false)
    .enablePartitionMerge(false)
    .enablePerRegionPerPartitionAutoscale(false)
    .identity(ManagedServiceIdentityArgs.builder()
        .type("SystemAssigned")
        .userAssignedIdentities("string")
        .build())
    .ipRules(IpAddressOrRangeArgs.builder()
        .ipAddressOrRange("string")
        .build())
    .isVirtualNetworkFilterEnabled(false)
    .keyVaultKeyUri("string")
    .kind("string")
    .location("string")
    .apiProperties(ApiPropertiesArgs.builder()
        .serverVersion("string")
        .build())
    .minimalTlsVersion("string")
    .networkAclBypass("None")
    .networkAclBypassResourceIds("string")
    .publicNetworkAccess("string")
    .analyticalStorageConfiguration(AnalyticalStorageConfigurationArgs.builder()
        .schemaType("string")
        .build())
    .restoreParameters(RestoreParametersArgs.builder()
        .databasesToRestore(DatabaseRestoreResourceArgs.builder()
            .collectionNames("string")
            .databaseName("string")
            .build())
        .gremlinDatabasesToRestore(GremlinDatabaseRestoreResourceArgs.builder()
            .databaseName("string")
            .graphNames("string")
            .build())
        .restoreMode("string")
        .restoreSource("string")
        .restoreTimestampInUtc("string")
        .restoreWithTtlDisabled(false)
        .tablesToRestore("string")
        .build())
    .tags(Map.of("string", "string"))
    .virtualNetworkRules(VirtualNetworkRuleArgs.builder()
        .id("string")
        .ignoreMissingVNetServiceEndpoint(false)
        .build())
    .build());
Copy
database_account_resource = azure_native.cosmosdb.DatabaseAccount("databaseAccountResource",
    database_account_offer_type=azure_native.cosmosdb.DatabaseAccountOfferType.STANDARD,
    resource_group_name="string",
    locations=[{
        "failover_priority": 0,
        "is_zone_redundant": False,
        "location_name": "string",
    }],
    enable_cassandra_connector=False,
    enable_multiple_write_locations=False,
    capacity={
        "total_throughput_limit": 0,
    },
    connector_offer="string",
    consistency_policy={
        "default_consistency_level": azure_native.cosmosdb.DefaultConsistencyLevel.EVENTUAL,
        "max_interval_in_seconds": 0,
        "max_staleness_prefix": 0,
    },
    cors=[{
        "allowed_origins": "string",
        "allowed_headers": "string",
        "allowed_methods": "string",
        "exposed_headers": "string",
        "max_age_in_seconds": 0,
    }],
    create_mode="string",
    customer_managed_key_status="string",
    backup_policy={
        "type": "Continuous",
        "continuous_mode_properties": {
            "tier": "string",
        },
        "migration_state": {
            "start_time": "string",
            "status": "string",
            "target_type": "string",
        },
    },
    default_identity="string",
    disable_key_based_metadata_write_access=False,
    disable_local_auth=False,
    enable_analytical_storage=False,
    enable_automatic_failover=False,
    enable_burst_capacity=False,
    account_name="string",
    capabilities=[{
        "name": "string",
    }],
    enable_free_tier=False,
    enable_partition_merge=False,
    enable_per_region_per_partition_autoscale=False,
    identity={
        "type": azure_native.cosmosdb.ResourceIdentityType.SYSTEM_ASSIGNED,
        "user_assigned_identities": ["string"],
    },
    ip_rules=[{
        "ip_address_or_range": "string",
    }],
    is_virtual_network_filter_enabled=False,
    key_vault_key_uri="string",
    kind="string",
    location="string",
    api_properties={
        "server_version": "string",
    },
    minimal_tls_version="string",
    network_acl_bypass=azure_native.cosmosdb.NetworkAclBypass.NONE,
    network_acl_bypass_resource_ids=["string"],
    public_network_access="string",
    analytical_storage_configuration={
        "schema_type": "string",
    },
    restore_parameters={
        "databases_to_restore": [{
            "collection_names": ["string"],
            "database_name": "string",
        }],
        "gremlin_databases_to_restore": [{
            "database_name": "string",
            "graph_names": ["string"],
        }],
        "restore_mode": "string",
        "restore_source": "string",
        "restore_timestamp_in_utc": "string",
        "restore_with_ttl_disabled": False,
        "tables_to_restore": ["string"],
    },
    tags={
        "string": "string",
    },
    virtual_network_rules=[{
        "id": "string",
        "ignore_missing_v_net_service_endpoint": False,
    }])
Copy
const databaseAccountResource = new azure_native.cosmosdb.DatabaseAccount("databaseAccountResource", {
    databaseAccountOfferType: azure_native.cosmosdb.DatabaseAccountOfferType.Standard,
    resourceGroupName: "string",
    locations: [{
        failoverPriority: 0,
        isZoneRedundant: false,
        locationName: "string",
    }],
    enableCassandraConnector: false,
    enableMultipleWriteLocations: false,
    capacity: {
        totalThroughputLimit: 0,
    },
    connectorOffer: "string",
    consistencyPolicy: {
        defaultConsistencyLevel: azure_native.cosmosdb.DefaultConsistencyLevel.Eventual,
        maxIntervalInSeconds: 0,
        maxStalenessPrefix: 0,
    },
    cors: [{
        allowedOrigins: "string",
        allowedHeaders: "string",
        allowedMethods: "string",
        exposedHeaders: "string",
        maxAgeInSeconds: 0,
    }],
    createMode: "string",
    customerManagedKeyStatus: "string",
    backupPolicy: {
        type: "Continuous",
        continuousModeProperties: {
            tier: "string",
        },
        migrationState: {
            startTime: "string",
            status: "string",
            targetType: "string",
        },
    },
    defaultIdentity: "string",
    disableKeyBasedMetadataWriteAccess: false,
    disableLocalAuth: false,
    enableAnalyticalStorage: false,
    enableAutomaticFailover: false,
    enableBurstCapacity: false,
    accountName: "string",
    capabilities: [{
        name: "string",
    }],
    enableFreeTier: false,
    enablePartitionMerge: false,
    enablePerRegionPerPartitionAutoscale: false,
    identity: {
        type: azure_native.cosmosdb.ResourceIdentityType.SystemAssigned,
        userAssignedIdentities: ["string"],
    },
    ipRules: [{
        ipAddressOrRange: "string",
    }],
    isVirtualNetworkFilterEnabled: false,
    keyVaultKeyUri: "string",
    kind: "string",
    location: "string",
    apiProperties: {
        serverVersion: "string",
    },
    minimalTlsVersion: "string",
    networkAclBypass: azure_native.cosmosdb.NetworkAclBypass.None,
    networkAclBypassResourceIds: ["string"],
    publicNetworkAccess: "string",
    analyticalStorageConfiguration: {
        schemaType: "string",
    },
    restoreParameters: {
        databasesToRestore: [{
            collectionNames: ["string"],
            databaseName: "string",
        }],
        gremlinDatabasesToRestore: [{
            databaseName: "string",
            graphNames: ["string"],
        }],
        restoreMode: "string",
        restoreSource: "string",
        restoreTimestampInUtc: "string",
        restoreWithTtlDisabled: false,
        tablesToRestore: ["string"],
    },
    tags: {
        string: "string",
    },
    virtualNetworkRules: [{
        id: "string",
        ignoreMissingVNetServiceEndpoint: false,
    }],
});
Copy
type: azure-native:cosmosdb:DatabaseAccount
properties:
    accountName: string
    analyticalStorageConfiguration:
        schemaType: string
    apiProperties:
        serverVersion: string
    backupPolicy:
        continuousModeProperties:
            tier: string
        migrationState:
            startTime: string
            status: string
            targetType: string
        type: Continuous
    capabilities:
        - name: string
    capacity:
        totalThroughputLimit: 0
    connectorOffer: string
    consistencyPolicy:
        defaultConsistencyLevel: Eventual
        maxIntervalInSeconds: 0
        maxStalenessPrefix: 0
    cors:
        - allowedHeaders: string
          allowedMethods: string
          allowedOrigins: string
          exposedHeaders: string
          maxAgeInSeconds: 0
    createMode: string
    customerManagedKeyStatus: string
    databaseAccountOfferType: Standard
    defaultIdentity: string
    disableKeyBasedMetadataWriteAccess: false
    disableLocalAuth: false
    enableAnalyticalStorage: false
    enableAutomaticFailover: false
    enableBurstCapacity: false
    enableCassandraConnector: false
    enableFreeTier: false
    enableMultipleWriteLocations: false
    enablePartitionMerge: false
    enablePerRegionPerPartitionAutoscale: false
    identity:
        type: SystemAssigned
        userAssignedIdentities:
            - string
    ipRules:
        - ipAddressOrRange: string
    isVirtualNetworkFilterEnabled: false
    keyVaultKeyUri: string
    kind: string
    location: string
    locations:
        - failoverPriority: 0
          isZoneRedundant: false
          locationName: string
    minimalTlsVersion: string
    networkAclBypass: None
    networkAclBypassResourceIds:
        - string
    publicNetworkAccess: string
    resourceGroupName: string
    restoreParameters:
        databasesToRestore:
            - collectionNames:
                - string
              databaseName: string
        gremlinDatabasesToRestore:
            - databaseName: string
              graphNames:
                - string
        restoreMode: string
        restoreSource: string
        restoreTimestampInUtc: string
        restoreWithTtlDisabled: false
        tablesToRestore:
            - string
    tags:
        string: string
    virtualNetworkRules:
        - id: string
          ignoreMissingVNetServiceEndpoint: false
Copy

DatabaseAccount Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DatabaseAccount resource accepts the following input properties:

DatabaseAccountOfferType This property is required. Pulumi.AzureNative.CosmosDB.DatabaseAccountOfferType
The offer type for the database
Locations This property is required. List<Pulumi.AzureNative.CosmosDB.Inputs.Location>
An array that contains the georeplication locations enabled for the Cosmos DB account.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AccountName Changes to this property will trigger replacement. string
Cosmos DB database account name.
AnalyticalStorageConfiguration Pulumi.AzureNative.CosmosDB.Inputs.AnalyticalStorageConfiguration
Analytical storage specific properties.
ApiProperties Pulumi.AzureNative.CosmosDB.Inputs.ApiProperties
API specific properties. Currently, supported only for MongoDB API.
BackupPolicy Pulumi.AzureNative.CosmosDB.Inputs.ContinuousModeBackupPolicy | Pulumi.AzureNative.CosmosDB.Inputs.PeriodicModeBackupPolicy
The object representing the policy for taking backups on an account.
Capabilities List<Pulumi.AzureNative.CosmosDB.Inputs.Capability>
List of Cosmos DB capabilities for the account
Capacity Pulumi.AzureNative.CosmosDB.Inputs.Capacity
The object that represents all properties related to capacity enforcement on an account.
ConnectorOffer string | Pulumi.AzureNative.CosmosDB.ConnectorOffer
The cassandra connector offer type for the Cosmos DB database C* account.
ConsistencyPolicy Pulumi.AzureNative.CosmosDB.Inputs.ConsistencyPolicy
The consistency policy for the Cosmos DB account.
Cors List<Pulumi.AzureNative.CosmosDB.Inputs.CorsPolicy>
The CORS policy for the Cosmos DB database account.
CreateMode string | Pulumi.AzureNative.CosmosDB.CreateMode
Enum to indicate the mode of account creation.
CustomerManagedKeyStatus string
Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
DefaultIdentity string
The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
DisableKeyBasedMetadataWriteAccess bool
Disable write operations on metadata resources (databases, containers, throughput) via account keys
DisableLocalAuth bool
Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
EnableAnalyticalStorage bool
Flag to indicate whether to enable storage analytics.
EnableAutomaticFailover bool
Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
EnableBurstCapacity bool
Flag to indicate enabling/disabling of Burst Capacity feature on the account
EnableCassandraConnector bool
Enables the cassandra connector on the Cosmos DB C* account
EnableFreeTier bool
Flag to indicate whether Free Tier is enabled.
EnableMultipleWriteLocations bool
Enables the account to write in multiple locations
EnablePartitionMerge bool
Flag to indicate enabling/disabling of Partition Merge feature on the account
EnablePerRegionPerPartitionAutoscale bool
Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account
Identity Pulumi.AzureNative.CosmosDB.Inputs.ManagedServiceIdentity
Identity for the resource.
IpRules List<Pulumi.AzureNative.CosmosDB.Inputs.IpAddressOrRange>
List of IpRules.
IsVirtualNetworkFilterEnabled bool
Flag to indicate whether to enable/disable Virtual Network ACL rules.
KeyVaultKeyUri string
The URI of the key vault
Kind string | Pulumi.AzureNative.CosmosDB.DatabaseAccountKind
Indicates the type of database account. This can only be set at database account creation.
Location string
The location of the resource group to which the resource belongs.
MinimalTlsVersion string | Pulumi.AzureNative.CosmosDB.MinimalTlsVersion
Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.
NetworkAclBypass Pulumi.AzureNative.CosmosDB.NetworkAclBypass
Indicates what services are allowed to bypass firewall checks.
NetworkAclBypassResourceIds List<string>
An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
PublicNetworkAccess string | Pulumi.AzureNative.CosmosDB.PublicNetworkAccess
Whether requests from Public Network are allowed
RestoreParameters Changes to this property will trigger replacement. Pulumi.AzureNative.CosmosDB.Inputs.RestoreParameters
Parameters to indicate the information about the restore.
Tags Dictionary<string, string>
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
VirtualNetworkRules List<Pulumi.AzureNative.CosmosDB.Inputs.VirtualNetworkRule>
List of Virtual Network ACL rules configured for the Cosmos DB account.
DatabaseAccountOfferType This property is required. DatabaseAccountOfferType
The offer type for the database
Locations This property is required. []LocationArgs
An array that contains the georeplication locations enabled for the Cosmos DB account.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AccountName Changes to this property will trigger replacement. string
Cosmos DB database account name.
AnalyticalStorageConfiguration AnalyticalStorageConfigurationArgs
Analytical storage specific properties.
ApiProperties ApiPropertiesArgs
API specific properties. Currently, supported only for MongoDB API.
BackupPolicy ContinuousModeBackupPolicyArgs | PeriodicModeBackupPolicyArgs
The object representing the policy for taking backups on an account.
Capabilities []CapabilityArgs
List of Cosmos DB capabilities for the account
Capacity CapacityArgs
The object that represents all properties related to capacity enforcement on an account.
ConnectorOffer string | ConnectorOffer
The cassandra connector offer type for the Cosmos DB database C* account.
ConsistencyPolicy ConsistencyPolicyArgs
The consistency policy for the Cosmos DB account.
Cors []CorsPolicyArgs
The CORS policy for the Cosmos DB database account.
CreateMode string | CreateMode
Enum to indicate the mode of account creation.
CustomerManagedKeyStatus string
Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
DefaultIdentity string
The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
DisableKeyBasedMetadataWriteAccess bool
Disable write operations on metadata resources (databases, containers, throughput) via account keys
DisableLocalAuth bool
Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
EnableAnalyticalStorage bool
Flag to indicate whether to enable storage analytics.
EnableAutomaticFailover bool
Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
EnableBurstCapacity bool
Flag to indicate enabling/disabling of Burst Capacity feature on the account
EnableCassandraConnector bool
Enables the cassandra connector on the Cosmos DB C* account
EnableFreeTier bool
Flag to indicate whether Free Tier is enabled.
EnableMultipleWriteLocations bool
Enables the account to write in multiple locations
EnablePartitionMerge bool
Flag to indicate enabling/disabling of Partition Merge feature on the account
EnablePerRegionPerPartitionAutoscale bool
Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account
Identity ManagedServiceIdentityArgs
Identity for the resource.
IpRules []IpAddressOrRangeArgs
List of IpRules.
IsVirtualNetworkFilterEnabled bool
Flag to indicate whether to enable/disable Virtual Network ACL rules.
KeyVaultKeyUri string
The URI of the key vault
Kind string | DatabaseAccountKind
Indicates the type of database account. This can only be set at database account creation.
Location string
The location of the resource group to which the resource belongs.
MinimalTlsVersion string | MinimalTlsVersion
Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.
NetworkAclBypass NetworkAclBypass
Indicates what services are allowed to bypass firewall checks.
NetworkAclBypassResourceIds []string
An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
PublicNetworkAccess string | PublicNetworkAccess
Whether requests from Public Network are allowed
RestoreParameters Changes to this property will trigger replacement. RestoreParametersArgs
Parameters to indicate the information about the restore.
Tags map[string]string
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
VirtualNetworkRules []VirtualNetworkRuleArgs
List of Virtual Network ACL rules configured for the Cosmos DB account.
databaseAccountOfferType This property is required. DatabaseAccountOfferType
The offer type for the database
locations This property is required. List<Location>
An array that contains the georeplication locations enabled for the Cosmos DB account.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
accountName Changes to this property will trigger replacement. String
Cosmos DB database account name.
analyticalStorageConfiguration AnalyticalStorageConfiguration
Analytical storage specific properties.
apiProperties ApiProperties
API specific properties. Currently, supported only for MongoDB API.
backupPolicy ContinuousModeBackupPolicy | PeriodicModeBackupPolicy
The object representing the policy for taking backups on an account.
capabilities List<Capability>
List of Cosmos DB capabilities for the account
capacity Capacity
The object that represents all properties related to capacity enforcement on an account.
connectorOffer String | ConnectorOffer
The cassandra connector offer type for the Cosmos DB database C* account.
consistencyPolicy ConsistencyPolicy
The consistency policy for the Cosmos DB account.
cors List<CorsPolicy>
The CORS policy for the Cosmos DB database account.
createMode String | CreateMode
Enum to indicate the mode of account creation.
customerManagedKeyStatus String
Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
defaultIdentity String
The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
disableKeyBasedMetadataWriteAccess Boolean
Disable write operations on metadata resources (databases, containers, throughput) via account keys
disableLocalAuth Boolean
Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
enableAnalyticalStorage Boolean
Flag to indicate whether to enable storage analytics.
enableAutomaticFailover Boolean
Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
enableBurstCapacity Boolean
Flag to indicate enabling/disabling of Burst Capacity feature on the account
enableCassandraConnector Boolean
Enables the cassandra connector on the Cosmos DB C* account
enableFreeTier Boolean
Flag to indicate whether Free Tier is enabled.
enableMultipleWriteLocations Boolean
Enables the account to write in multiple locations
enablePartitionMerge Boolean
Flag to indicate enabling/disabling of Partition Merge feature on the account
enablePerRegionPerPartitionAutoscale Boolean
Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account
identity ManagedServiceIdentity
Identity for the resource.
ipRules List<IpAddressOrRange>
List of IpRules.
isVirtualNetworkFilterEnabled Boolean
Flag to indicate whether to enable/disable Virtual Network ACL rules.
keyVaultKeyUri String
The URI of the key vault
kind String | DatabaseAccountKind
Indicates the type of database account. This can only be set at database account creation.
location String
The location of the resource group to which the resource belongs.
minimalTlsVersion String | MinimalTlsVersion
Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.
networkAclBypass NetworkAclBypass
Indicates what services are allowed to bypass firewall checks.
networkAclBypassResourceIds List<String>
An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
publicNetworkAccess String | PublicNetworkAccess
Whether requests from Public Network are allowed
restoreParameters Changes to this property will trigger replacement. RestoreParameters
Parameters to indicate the information about the restore.
tags Map<String,String>
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
virtualNetworkRules List<VirtualNetworkRule>
List of Virtual Network ACL rules configured for the Cosmos DB account.
databaseAccountOfferType This property is required. DatabaseAccountOfferType
The offer type for the database
locations This property is required. Location[]
An array that contains the georeplication locations enabled for the Cosmos DB account.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
accountName Changes to this property will trigger replacement. string
Cosmos DB database account name.
analyticalStorageConfiguration AnalyticalStorageConfiguration
Analytical storage specific properties.
apiProperties ApiProperties
API specific properties. Currently, supported only for MongoDB API.
backupPolicy ContinuousModeBackupPolicy | PeriodicModeBackupPolicy
The object representing the policy for taking backups on an account.
capabilities Capability[]
List of Cosmos DB capabilities for the account
capacity Capacity
The object that represents all properties related to capacity enforcement on an account.
connectorOffer string | ConnectorOffer
The cassandra connector offer type for the Cosmos DB database C* account.
consistencyPolicy ConsistencyPolicy
The consistency policy for the Cosmos DB account.
cors CorsPolicy[]
The CORS policy for the Cosmos DB database account.
createMode string | CreateMode
Enum to indicate the mode of account creation.
customerManagedKeyStatus string
Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
defaultIdentity string
The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
disableKeyBasedMetadataWriteAccess boolean
Disable write operations on metadata resources (databases, containers, throughput) via account keys
disableLocalAuth boolean
Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
enableAnalyticalStorage boolean
Flag to indicate whether to enable storage analytics.
enableAutomaticFailover boolean
Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
enableBurstCapacity boolean
Flag to indicate enabling/disabling of Burst Capacity feature on the account
enableCassandraConnector boolean
Enables the cassandra connector on the Cosmos DB C* account
enableFreeTier boolean
Flag to indicate whether Free Tier is enabled.
enableMultipleWriteLocations boolean
Enables the account to write in multiple locations
enablePartitionMerge boolean
Flag to indicate enabling/disabling of Partition Merge feature on the account
enablePerRegionPerPartitionAutoscale boolean
Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account
identity ManagedServiceIdentity
Identity for the resource.
ipRules IpAddressOrRange[]
List of IpRules.
isVirtualNetworkFilterEnabled boolean
Flag to indicate whether to enable/disable Virtual Network ACL rules.
keyVaultKeyUri string
The URI of the key vault
kind string | DatabaseAccountKind
Indicates the type of database account. This can only be set at database account creation.
location string
The location of the resource group to which the resource belongs.
minimalTlsVersion string | MinimalTlsVersion
Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.
networkAclBypass NetworkAclBypass
Indicates what services are allowed to bypass firewall checks.
networkAclBypassResourceIds string[]
An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
publicNetworkAccess string | PublicNetworkAccess
Whether requests from Public Network are allowed
restoreParameters Changes to this property will trigger replacement. RestoreParameters
Parameters to indicate the information about the restore.
tags {[key: string]: string}
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
virtualNetworkRules VirtualNetworkRule[]
List of Virtual Network ACL rules configured for the Cosmos DB account.
database_account_offer_type This property is required. DatabaseAccountOfferType
The offer type for the database
locations This property is required. Sequence[LocationArgs]
An array that contains the georeplication locations enabled for the Cosmos DB account.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
account_name Changes to this property will trigger replacement. str
Cosmos DB database account name.
analytical_storage_configuration AnalyticalStorageConfigurationArgs
Analytical storage specific properties.
api_properties ApiPropertiesArgs
API specific properties. Currently, supported only for MongoDB API.
backup_policy ContinuousModeBackupPolicyArgs | PeriodicModeBackupPolicyArgs
The object representing the policy for taking backups on an account.
capabilities Sequence[CapabilityArgs]
List of Cosmos DB capabilities for the account
capacity CapacityArgs
The object that represents all properties related to capacity enforcement on an account.
connector_offer str | ConnectorOffer
The cassandra connector offer type for the Cosmos DB database C* account.
consistency_policy ConsistencyPolicyArgs
The consistency policy for the Cosmos DB account.
cors Sequence[CorsPolicyArgs]
The CORS policy for the Cosmos DB database account.
create_mode str | CreateMode
Enum to indicate the mode of account creation.
customer_managed_key_status str
Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
default_identity str
The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
disable_key_based_metadata_write_access bool
Disable write operations on metadata resources (databases, containers, throughput) via account keys
disable_local_auth bool
Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
enable_analytical_storage bool
Flag to indicate whether to enable storage analytics.
enable_automatic_failover bool
Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
enable_burst_capacity bool
Flag to indicate enabling/disabling of Burst Capacity feature on the account
enable_cassandra_connector bool
Enables the cassandra connector on the Cosmos DB C* account
enable_free_tier bool
Flag to indicate whether Free Tier is enabled.
enable_multiple_write_locations bool
Enables the account to write in multiple locations
enable_partition_merge bool
Flag to indicate enabling/disabling of Partition Merge feature on the account
enable_per_region_per_partition_autoscale bool
Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account
identity ManagedServiceIdentityArgs
Identity for the resource.
ip_rules Sequence[IpAddressOrRangeArgs]
List of IpRules.
is_virtual_network_filter_enabled bool
Flag to indicate whether to enable/disable Virtual Network ACL rules.
key_vault_key_uri str
The URI of the key vault
kind str | DatabaseAccountKind
Indicates the type of database account. This can only be set at database account creation.
location str
The location of the resource group to which the resource belongs.
minimal_tls_version str | MinimalTlsVersion
Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.
network_acl_bypass NetworkAclBypass
Indicates what services are allowed to bypass firewall checks.
network_acl_bypass_resource_ids Sequence[str]
An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
public_network_access str | PublicNetworkAccess
Whether requests from Public Network are allowed
restore_parameters Changes to this property will trigger replacement. RestoreParametersArgs
Parameters to indicate the information about the restore.
tags Mapping[str, str]
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
virtual_network_rules Sequence[VirtualNetworkRuleArgs]
List of Virtual Network ACL rules configured for the Cosmos DB account.
databaseAccountOfferType This property is required. "Standard"
The offer type for the database
locations This property is required. List<Property Map>
An array that contains the georeplication locations enabled for the Cosmos DB account.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
accountName Changes to this property will trigger replacement. String
Cosmos DB database account name.
analyticalStorageConfiguration Property Map
Analytical storage specific properties.
apiProperties Property Map
API specific properties. Currently, supported only for MongoDB API.
backupPolicy Property Map | Property Map
The object representing the policy for taking backups on an account.
capabilities List<Property Map>
List of Cosmos DB capabilities for the account
capacity Property Map
The object that represents all properties related to capacity enforcement on an account.
connectorOffer String | "Small"
The cassandra connector offer type for the Cosmos DB database C* account.
consistencyPolicy Property Map
The consistency policy for the Cosmos DB account.
cors List<Property Map>
The CORS policy for the Cosmos DB database account.
createMode String | "Default" | "Restore"
Enum to indicate the mode of account creation.
customerManagedKeyStatus String
Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
defaultIdentity String
The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
disableKeyBasedMetadataWriteAccess Boolean
Disable write operations on metadata resources (databases, containers, throughput) via account keys
disableLocalAuth Boolean
Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
enableAnalyticalStorage Boolean
Flag to indicate whether to enable storage analytics.
enableAutomaticFailover Boolean
Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
enableBurstCapacity Boolean
Flag to indicate enabling/disabling of Burst Capacity feature on the account
enableCassandraConnector Boolean
Enables the cassandra connector on the Cosmos DB C* account
enableFreeTier Boolean
Flag to indicate whether Free Tier is enabled.
enableMultipleWriteLocations Boolean
Enables the account to write in multiple locations
enablePartitionMerge Boolean
Flag to indicate enabling/disabling of Partition Merge feature on the account
enablePerRegionPerPartitionAutoscale Boolean
Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account
identity Property Map
Identity for the resource.
ipRules List<Property Map>
List of IpRules.
isVirtualNetworkFilterEnabled Boolean
Flag to indicate whether to enable/disable Virtual Network ACL rules.
keyVaultKeyUri String
The URI of the key vault
kind String | "GlobalDocumentDB" | "MongoDB" | "Parse"
Indicates the type of database account. This can only be set at database account creation.
location String
The location of the resource group to which the resource belongs.
minimalTlsVersion String | "Tls" | "Tls11" | "Tls12"
Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.
networkAclBypass "None" | "AzureServices"
Indicates what services are allowed to bypass firewall checks.
networkAclBypassResourceIds List<String>
An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
publicNetworkAccess String | "Enabled" | "Disabled" | "SecuredByPerimeter"
Whether requests from Public Network are allowed
restoreParameters Changes to this property will trigger replacement. Property Map
Parameters to indicate the information about the restore.
tags Map<String>
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
virtualNetworkRules List<Property Map>
List of Virtual Network ACL rules configured for the Cosmos DB account.

Outputs

All input properties are implicitly available as output properties. Additionally, the DatabaseAccount resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
DocumentEndpoint string
The connection endpoint for the Cosmos DB database account.
FailoverPolicies List<Pulumi.AzureNative.CosmosDB.Outputs.FailoverPolicyResponse>
An array that contains the regions ordered by their failover priorities.
Id string
The provider-assigned unique ID for this managed resource.
InstanceId string
A unique identifier assigned to the database account
KeysMetadata Pulumi.AzureNative.CosmosDB.Outputs.DatabaseAccountKeysMetadataResponse
The object that represents the metadata for the Account Keys of the Cosmos DB account.
Name string
The name of the ARM resource.
PrivateEndpointConnections List<Pulumi.AzureNative.CosmosDB.Outputs.PrivateEndpointConnectionResponse>
List of Private Endpoint Connections configured for the Cosmos DB account.
ProvisioningState string
The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.
ReadLocations List<Pulumi.AzureNative.CosmosDB.Outputs.LocationResponse>
An array that contains of the read locations enabled for the Cosmos DB account.
SystemData Pulumi.AzureNative.CosmosDB.Outputs.SystemDataResponse
The system meta data relating to this resource.
Type string
The type of Azure resource.
WriteLocations List<Pulumi.AzureNative.CosmosDB.Outputs.LocationResponse>
An array that contains the write location for the Cosmos DB account.
AzureApiVersion string
The Azure API version of the resource.
DocumentEndpoint string
The connection endpoint for the Cosmos DB database account.
FailoverPolicies []FailoverPolicyResponse
An array that contains the regions ordered by their failover priorities.
Id string
The provider-assigned unique ID for this managed resource.
InstanceId string
A unique identifier assigned to the database account
KeysMetadata DatabaseAccountKeysMetadataResponse
The object that represents the metadata for the Account Keys of the Cosmos DB account.
Name string
The name of the ARM resource.
PrivateEndpointConnections []PrivateEndpointConnectionResponse
List of Private Endpoint Connections configured for the Cosmos DB account.
ProvisioningState string
The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.
ReadLocations []LocationResponse
An array that contains of the read locations enabled for the Cosmos DB account.
SystemData SystemDataResponse
The system meta data relating to this resource.
Type string
The type of Azure resource.
WriteLocations []LocationResponse
An array that contains the write location for the Cosmos DB account.
azureApiVersion String
The Azure API version of the resource.
documentEndpoint String
The connection endpoint for the Cosmos DB database account.
failoverPolicies List<FailoverPolicyResponse>
An array that contains the regions ordered by their failover priorities.
id String
The provider-assigned unique ID for this managed resource.
instanceId String
A unique identifier assigned to the database account
keysMetadata DatabaseAccountKeysMetadataResponse
The object that represents the metadata for the Account Keys of the Cosmos DB account.
name String
The name of the ARM resource.
privateEndpointConnections List<PrivateEndpointConnectionResponse>
List of Private Endpoint Connections configured for the Cosmos DB account.
provisioningState String
The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.
readLocations List<LocationResponse>
An array that contains of the read locations enabled for the Cosmos DB account.
systemData SystemDataResponse
The system meta data relating to this resource.
type String
The type of Azure resource.
writeLocations List<LocationResponse>
An array that contains the write location for the Cosmos DB account.
azureApiVersion string
The Azure API version of the resource.
documentEndpoint string
The connection endpoint for the Cosmos DB database account.
failoverPolicies FailoverPolicyResponse[]
An array that contains the regions ordered by their failover priorities.
id string
The provider-assigned unique ID for this managed resource.
instanceId string
A unique identifier assigned to the database account
keysMetadata DatabaseAccountKeysMetadataResponse
The object that represents the metadata for the Account Keys of the Cosmos DB account.
name string
The name of the ARM resource.
privateEndpointConnections PrivateEndpointConnectionResponse[]
List of Private Endpoint Connections configured for the Cosmos DB account.
provisioningState string
The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.
readLocations LocationResponse[]
An array that contains of the read locations enabled for the Cosmos DB account.
systemData SystemDataResponse
The system meta data relating to this resource.
type string
The type of Azure resource.
writeLocations LocationResponse[]
An array that contains the write location for the Cosmos DB account.
azure_api_version str
The Azure API version of the resource.
document_endpoint str
The connection endpoint for the Cosmos DB database account.
failover_policies Sequence[FailoverPolicyResponse]
An array that contains the regions ordered by their failover priorities.
id str
The provider-assigned unique ID for this managed resource.
instance_id str
A unique identifier assigned to the database account
keys_metadata DatabaseAccountKeysMetadataResponse
The object that represents the metadata for the Account Keys of the Cosmos DB account.
name str
The name of the ARM resource.
private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
List of Private Endpoint Connections configured for the Cosmos DB account.
provisioning_state str
The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.
read_locations Sequence[LocationResponse]
An array that contains of the read locations enabled for the Cosmos DB account.
system_data SystemDataResponse
The system meta data relating to this resource.
type str
The type of Azure resource.
write_locations Sequence[LocationResponse]
An array that contains the write location for the Cosmos DB account.
azureApiVersion String
The Azure API version of the resource.
documentEndpoint String
The connection endpoint for the Cosmos DB database account.
failoverPolicies List<Property Map>
An array that contains the regions ordered by their failover priorities.
id String
The provider-assigned unique ID for this managed resource.
instanceId String
A unique identifier assigned to the database account
keysMetadata Property Map
The object that represents the metadata for the Account Keys of the Cosmos DB account.
name String
The name of the ARM resource.
privateEndpointConnections List<Property Map>
List of Private Endpoint Connections configured for the Cosmos DB account.
provisioningState String
The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.
readLocations List<Property Map>
An array that contains of the read locations enabled for the Cosmos DB account.
systemData Property Map
The system meta data relating to this resource.
type String
The type of Azure resource.
writeLocations List<Property Map>
An array that contains the write location for the Cosmos DB account.

Supporting Types

AccountKeyMetadataResponse
, AccountKeyMetadataResponseArgs

GenerationTime This property is required. string
Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18.
GenerationTime This property is required. string
Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18.
generationTime This property is required. String
Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18.
generationTime This property is required. string
Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18.
generation_time This property is required. str
Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18.
generationTime This property is required. String
Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18.

AnalyticalStorageConfiguration
, AnalyticalStorageConfigurationArgs

SchemaType string | Pulumi.AzureNative.CosmosDB.AnalyticalStorageSchemaType
Describes the types of schema for analytical storage.
SchemaType string | AnalyticalStorageSchemaType
Describes the types of schema for analytical storage.
schemaType String | AnalyticalStorageSchemaType
Describes the types of schema for analytical storage.
schemaType string | AnalyticalStorageSchemaType
Describes the types of schema for analytical storage.
schema_type str | AnalyticalStorageSchemaType
Describes the types of schema for analytical storage.
schemaType String | "WellDefined" | "FullFidelity"
Describes the types of schema for analytical storage.

AnalyticalStorageConfigurationResponse
, AnalyticalStorageConfigurationResponseArgs

SchemaType string
Describes the types of schema for analytical storage.
SchemaType string
Describes the types of schema for analytical storage.
schemaType String
Describes the types of schema for analytical storage.
schemaType string
Describes the types of schema for analytical storage.
schema_type str
Describes the types of schema for analytical storage.
schemaType String
Describes the types of schema for analytical storage.

AnalyticalStorageSchemaType
, AnalyticalStorageSchemaTypeArgs

WellDefined
WellDefined
FullFidelity
FullFidelity
AnalyticalStorageSchemaTypeWellDefined
WellDefined
AnalyticalStorageSchemaTypeFullFidelity
FullFidelity
WellDefined
WellDefined
FullFidelity
FullFidelity
WellDefined
WellDefined
FullFidelity
FullFidelity
WELL_DEFINED
WellDefined
FULL_FIDELITY
FullFidelity
"WellDefined"
WellDefined
"FullFidelity"
FullFidelity

ApiProperties
, ApiPropertiesArgs

ServerVersion string | Pulumi.AzureNative.CosmosDB.ServerVersion
Describes the version of the MongoDB account.
ServerVersion string | ServerVersion
Describes the version of the MongoDB account.
serverVersion String | ServerVersion
Describes the version of the MongoDB account.
serverVersion string | ServerVersion
Describes the version of the MongoDB account.
server_version str | ServerVersion
Describes the version of the MongoDB account.
serverVersion String | "3.2" | "3.6" | "4.0" | "4.2" | "5.0" | "6.0" | "7.0"
Describes the version of the MongoDB account.

ApiPropertiesResponse
, ApiPropertiesResponseArgs

ServerVersion string
Describes the version of the MongoDB account.
ServerVersion string
Describes the version of the MongoDB account.
serverVersion String
Describes the version of the MongoDB account.
serverVersion string
Describes the version of the MongoDB account.
server_version str
Describes the version of the MongoDB account.
serverVersion String
Describes the version of the MongoDB account.

BackupPolicyMigrationState
, BackupPolicyMigrationStateArgs

StartTime string
Time at which the backup policy migration started (ISO-8601 format).
Status string | Pulumi.AzureNative.CosmosDB.BackupPolicyMigrationStatus
Describes the status of migration between backup policy types.
TargetType string | Pulumi.AzureNative.CosmosDB.BackupPolicyType
Describes the target backup policy type of the backup policy migration.
StartTime string
Time at which the backup policy migration started (ISO-8601 format).
Status string | BackupPolicyMigrationStatus
Describes the status of migration between backup policy types.
TargetType string | BackupPolicyType
Describes the target backup policy type of the backup policy migration.
startTime String
Time at which the backup policy migration started (ISO-8601 format).
status String | BackupPolicyMigrationStatus
Describes the status of migration between backup policy types.
targetType String | BackupPolicyType
Describes the target backup policy type of the backup policy migration.
startTime string
Time at which the backup policy migration started (ISO-8601 format).
status string | BackupPolicyMigrationStatus
Describes the status of migration between backup policy types.
targetType string | BackupPolicyType
Describes the target backup policy type of the backup policy migration.
start_time str
Time at which the backup policy migration started (ISO-8601 format).
status str | BackupPolicyMigrationStatus
Describes the status of migration between backup policy types.
target_type str | BackupPolicyType
Describes the target backup policy type of the backup policy migration.
startTime String
Time at which the backup policy migration started (ISO-8601 format).
status String | "Invalid" | "InProgress" | "Completed" | "Failed"
Describes the status of migration between backup policy types.
targetType String | "Periodic" | "Continuous"
Describes the target backup policy type of the backup policy migration.

BackupPolicyMigrationStateResponse
, BackupPolicyMigrationStateResponseArgs

StartTime string
Time at which the backup policy migration started (ISO-8601 format).
Status string
Describes the status of migration between backup policy types.
TargetType string
Describes the target backup policy type of the backup policy migration.
StartTime string
Time at which the backup policy migration started (ISO-8601 format).
Status string
Describes the status of migration between backup policy types.
TargetType string
Describes the target backup policy type of the backup policy migration.
startTime String
Time at which the backup policy migration started (ISO-8601 format).
status String
Describes the status of migration between backup policy types.
targetType String
Describes the target backup policy type of the backup policy migration.
startTime string
Time at which the backup policy migration started (ISO-8601 format).
status string
Describes the status of migration between backup policy types.
targetType string
Describes the target backup policy type of the backup policy migration.
start_time str
Time at which the backup policy migration started (ISO-8601 format).
status str
Describes the status of migration between backup policy types.
target_type str
Describes the target backup policy type of the backup policy migration.
startTime String
Time at which the backup policy migration started (ISO-8601 format).
status String
Describes the status of migration between backup policy types.
targetType String
Describes the target backup policy type of the backup policy migration.

BackupPolicyMigrationStatus
, BackupPolicyMigrationStatusArgs

Invalid
Invalid
InProgress
InProgress
Completed
Completed
Failed
Failed
BackupPolicyMigrationStatusInvalid
Invalid
BackupPolicyMigrationStatusInProgress
InProgress
BackupPolicyMigrationStatusCompleted
Completed
BackupPolicyMigrationStatusFailed
Failed
Invalid
Invalid
InProgress
InProgress
Completed
Completed
Failed
Failed
Invalid
Invalid
InProgress
InProgress
Completed
Completed
Failed
Failed
INVALID
Invalid
IN_PROGRESS
InProgress
COMPLETED
Completed
FAILED
Failed
"Invalid"
Invalid
"InProgress"
InProgress
"Completed"
Completed
"Failed"
Failed

BackupPolicyType
, BackupPolicyTypeArgs

Periodic
Periodic
Continuous
Continuous
BackupPolicyTypePeriodic
Periodic
BackupPolicyTypeContinuous
Continuous
Periodic
Periodic
Continuous
Continuous
Periodic
Periodic
Continuous
Continuous
PERIODIC
Periodic
CONTINUOUS
Continuous
"Periodic"
Periodic
"Continuous"
Continuous

BackupStorageRedundancy
, BackupStorageRedundancyArgs

Geo
Geo
Local
Local
Zone
Zone
BackupStorageRedundancyGeo
Geo
BackupStorageRedundancyLocal
Local
BackupStorageRedundancyZone
Zone
Geo
Geo
Local
Local
Zone
Zone
Geo
Geo
Local
Local
Zone
Zone
GEO
Geo
LOCAL
Local
ZONE
Zone
"Geo"
Geo
"Local"
Local
"Zone"
Zone

Capability
, CapabilityArgs

Name string
Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".
Name string
Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".
name String
Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".
name string
Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".
name str
Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".
name String
Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".

CapabilityResponse
, CapabilityResponseArgs

Name string
Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".
Name string
Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".
name String
Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".
name string
Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".
name str
Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".
name String
Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".

Capacity
, CapacityArgs

TotalThroughputLimit int
The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.
TotalThroughputLimit int
The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.
totalThroughputLimit Integer
The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.
totalThroughputLimit number
The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.
total_throughput_limit int
The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.
totalThroughputLimit Number
The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.

CapacityResponse
, CapacityResponseArgs

TotalThroughputLimit int
The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.
TotalThroughputLimit int
The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.
totalThroughputLimit Integer
The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.
totalThroughputLimit number
The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.
total_throughput_limit int
The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.
totalThroughputLimit Number
The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.

ConnectorOffer
, ConnectorOfferArgs

Small
Small
ConnectorOfferSmall
Small
Small
Small
Small
Small
SMALL
Small
"Small"
Small

ConsistencyPolicy
, ConsistencyPolicyArgs

DefaultConsistencyLevel This property is required. Pulumi.AzureNative.CosmosDB.DefaultConsistencyLevel
The default consistency level and configuration settings of the Cosmos DB account.
MaxIntervalInSeconds int
When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
MaxStalenessPrefix double
When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
DefaultConsistencyLevel This property is required. DefaultConsistencyLevel
The default consistency level and configuration settings of the Cosmos DB account.
MaxIntervalInSeconds int
When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
MaxStalenessPrefix float64
When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
defaultConsistencyLevel This property is required. DefaultConsistencyLevel
The default consistency level and configuration settings of the Cosmos DB account.
maxIntervalInSeconds Integer
When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
maxStalenessPrefix Double
When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
defaultConsistencyLevel This property is required. DefaultConsistencyLevel
The default consistency level and configuration settings of the Cosmos DB account.
maxIntervalInSeconds number
When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
maxStalenessPrefix number
When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
default_consistency_level This property is required. DefaultConsistencyLevel
The default consistency level and configuration settings of the Cosmos DB account.
max_interval_in_seconds int
When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
max_staleness_prefix float
When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
defaultConsistencyLevel This property is required. "Eventual" | "Session" | "BoundedStaleness" | "Strong" | "ConsistentPrefix"
The default consistency level and configuration settings of the Cosmos DB account.
maxIntervalInSeconds Number
When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
maxStalenessPrefix Number
When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.

ConsistencyPolicyResponse
, ConsistencyPolicyResponseArgs

DefaultConsistencyLevel This property is required. string
The default consistency level and configuration settings of the Cosmos DB account.
MaxIntervalInSeconds int
When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
MaxStalenessPrefix double
When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
DefaultConsistencyLevel This property is required. string
The default consistency level and configuration settings of the Cosmos DB account.
MaxIntervalInSeconds int
When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
MaxStalenessPrefix float64
When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
defaultConsistencyLevel This property is required. String
The default consistency level and configuration settings of the Cosmos DB account.
maxIntervalInSeconds Integer
When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
maxStalenessPrefix Double
When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
defaultConsistencyLevel This property is required. string
The default consistency level and configuration settings of the Cosmos DB account.
maxIntervalInSeconds number
When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
maxStalenessPrefix number
When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
default_consistency_level This property is required. str
The default consistency level and configuration settings of the Cosmos DB account.
max_interval_in_seconds int
When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
max_staleness_prefix float
When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
defaultConsistencyLevel This property is required. String
The default consistency level and configuration settings of the Cosmos DB account.
maxIntervalInSeconds Number
When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
maxStalenessPrefix Number
When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.

ContinuousModeBackupPolicy
, ContinuousModeBackupPolicyArgs

ContinuousModeProperties Pulumi.AzureNative.CosmosDB.Inputs.ContinuousModeProperties
Configuration values for continuous mode backup
MigrationState Pulumi.AzureNative.CosmosDB.Inputs.BackupPolicyMigrationState
The object representing the state of the migration between the backup policies.
ContinuousModeProperties ContinuousModeProperties
Configuration values for continuous mode backup
MigrationState BackupPolicyMigrationState
The object representing the state of the migration between the backup policies.
continuousModeProperties ContinuousModeProperties
Configuration values for continuous mode backup
migrationState BackupPolicyMigrationState
The object representing the state of the migration between the backup policies.
continuousModeProperties ContinuousModeProperties
Configuration values for continuous mode backup
migrationState BackupPolicyMigrationState
The object representing the state of the migration between the backup policies.
continuous_mode_properties ContinuousModeProperties
Configuration values for continuous mode backup
migration_state BackupPolicyMigrationState
The object representing the state of the migration between the backup policies.
continuousModeProperties Property Map
Configuration values for continuous mode backup
migrationState Property Map
The object representing the state of the migration between the backup policies.

ContinuousModeBackupPolicyResponse
, ContinuousModeBackupPolicyResponseArgs

ContinuousModeProperties Pulumi.AzureNative.CosmosDB.Inputs.ContinuousModePropertiesResponse
Configuration values for continuous mode backup
MigrationState Pulumi.AzureNative.CosmosDB.Inputs.BackupPolicyMigrationStateResponse
The object representing the state of the migration between the backup policies.
ContinuousModeProperties ContinuousModePropertiesResponse
Configuration values for continuous mode backup
MigrationState BackupPolicyMigrationStateResponse
The object representing the state of the migration between the backup policies.
continuousModeProperties ContinuousModePropertiesResponse
Configuration values for continuous mode backup
migrationState BackupPolicyMigrationStateResponse
The object representing the state of the migration between the backup policies.
continuousModeProperties ContinuousModePropertiesResponse
Configuration values for continuous mode backup
migrationState BackupPolicyMigrationStateResponse
The object representing the state of the migration between the backup policies.
continuous_mode_properties ContinuousModePropertiesResponse
Configuration values for continuous mode backup
migration_state BackupPolicyMigrationStateResponse
The object representing the state of the migration between the backup policies.
continuousModeProperties Property Map
Configuration values for continuous mode backup
migrationState Property Map
The object representing the state of the migration between the backup policies.

ContinuousModeProperties
, ContinuousModePropertiesArgs

Tier string | Pulumi.AzureNative.CosmosDB.ContinuousTier
Enum to indicate type of Continuous backup mode
Tier string | ContinuousTier
Enum to indicate type of Continuous backup mode
tier String | ContinuousTier
Enum to indicate type of Continuous backup mode
tier string | ContinuousTier
Enum to indicate type of Continuous backup mode
tier str | ContinuousTier
Enum to indicate type of Continuous backup mode
tier String | "Continuous7Days" | "Continuous30Days"
Enum to indicate type of Continuous backup mode

ContinuousModePropertiesResponse
, ContinuousModePropertiesResponseArgs

Tier string
Enum to indicate type of Continuous backup mode
Tier string
Enum to indicate type of Continuous backup mode
tier String
Enum to indicate type of Continuous backup mode
tier string
Enum to indicate type of Continuous backup mode
tier str
Enum to indicate type of Continuous backup mode
tier String
Enum to indicate type of Continuous backup mode

ContinuousTier
, ContinuousTierArgs

Continuous7Days
Continuous7Days
Continuous30Days
Continuous30Days
ContinuousTierContinuous7Days
Continuous7Days
ContinuousTierContinuous30Days
Continuous30Days
Continuous7Days
Continuous7Days
Continuous30Days
Continuous30Days
Continuous7Days
Continuous7Days
Continuous30Days
Continuous30Days
CONTINUOUS7_DAYS
Continuous7Days
CONTINUOUS30_DAYS
Continuous30Days
"Continuous7Days"
Continuous7Days
"Continuous30Days"
Continuous30Days

CorsPolicy
, CorsPolicyArgs

AllowedOrigins This property is required. string
The origin domains that are permitted to make a request against the service via CORS.
AllowedHeaders string
The request headers that the origin domain may specify on the CORS request.
AllowedMethods string
The methods (HTTP request verbs) that the origin domain may use for a CORS request.
ExposedHeaders string
The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
MaxAgeInSeconds double
The maximum amount time that a browser should cache the preflight OPTIONS request.
AllowedOrigins This property is required. string
The origin domains that are permitted to make a request against the service via CORS.
AllowedHeaders string
The request headers that the origin domain may specify on the CORS request.
AllowedMethods string
The methods (HTTP request verbs) that the origin domain may use for a CORS request.
ExposedHeaders string
The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
MaxAgeInSeconds float64
The maximum amount time that a browser should cache the preflight OPTIONS request.
allowedOrigins This property is required. String
The origin domains that are permitted to make a request against the service via CORS.
allowedHeaders String
The request headers that the origin domain may specify on the CORS request.
allowedMethods String
The methods (HTTP request verbs) that the origin domain may use for a CORS request.
exposedHeaders String
The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
maxAgeInSeconds Double
The maximum amount time that a browser should cache the preflight OPTIONS request.
allowedOrigins This property is required. string
The origin domains that are permitted to make a request against the service via CORS.
allowedHeaders string
The request headers that the origin domain may specify on the CORS request.
allowedMethods string
The methods (HTTP request verbs) that the origin domain may use for a CORS request.
exposedHeaders string
The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
maxAgeInSeconds number
The maximum amount time that a browser should cache the preflight OPTIONS request.
allowed_origins This property is required. str
The origin domains that are permitted to make a request against the service via CORS.
allowed_headers str
The request headers that the origin domain may specify on the CORS request.
allowed_methods str
The methods (HTTP request verbs) that the origin domain may use for a CORS request.
exposed_headers str
The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
max_age_in_seconds float
The maximum amount time that a browser should cache the preflight OPTIONS request.
allowedOrigins This property is required. String
The origin domains that are permitted to make a request against the service via CORS.
allowedHeaders String
The request headers that the origin domain may specify on the CORS request.
allowedMethods String
The methods (HTTP request verbs) that the origin domain may use for a CORS request.
exposedHeaders String
The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
maxAgeInSeconds Number
The maximum amount time that a browser should cache the preflight OPTIONS request.

CorsPolicyResponse
, CorsPolicyResponseArgs

AllowedOrigins This property is required. string
The origin domains that are permitted to make a request against the service via CORS.
AllowedHeaders string
The request headers that the origin domain may specify on the CORS request.
AllowedMethods string
The methods (HTTP request verbs) that the origin domain may use for a CORS request.
ExposedHeaders string
The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
MaxAgeInSeconds double
The maximum amount time that a browser should cache the preflight OPTIONS request.
AllowedOrigins This property is required. string
The origin domains that are permitted to make a request against the service via CORS.
AllowedHeaders string
The request headers that the origin domain may specify on the CORS request.
AllowedMethods string
The methods (HTTP request verbs) that the origin domain may use for a CORS request.
ExposedHeaders string
The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
MaxAgeInSeconds float64
The maximum amount time that a browser should cache the preflight OPTIONS request.
allowedOrigins This property is required. String
The origin domains that are permitted to make a request against the service via CORS.
allowedHeaders String
The request headers that the origin domain may specify on the CORS request.
allowedMethods String
The methods (HTTP request verbs) that the origin domain may use for a CORS request.
exposedHeaders String
The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
maxAgeInSeconds Double
The maximum amount time that a browser should cache the preflight OPTIONS request.
allowedOrigins This property is required. string
The origin domains that are permitted to make a request against the service via CORS.
allowedHeaders string
The request headers that the origin domain may specify on the CORS request.
allowedMethods string
The methods (HTTP request verbs) that the origin domain may use for a CORS request.
exposedHeaders string
The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
maxAgeInSeconds number
The maximum amount time that a browser should cache the preflight OPTIONS request.
allowed_origins This property is required. str
The origin domains that are permitted to make a request against the service via CORS.
allowed_headers str
The request headers that the origin domain may specify on the CORS request.
allowed_methods str
The methods (HTTP request verbs) that the origin domain may use for a CORS request.
exposed_headers str
The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
max_age_in_seconds float
The maximum amount time that a browser should cache the preflight OPTIONS request.
allowedOrigins This property is required. String
The origin domains that are permitted to make a request against the service via CORS.
allowedHeaders String
The request headers that the origin domain may specify on the CORS request.
allowedMethods String
The methods (HTTP request verbs) that the origin domain may use for a CORS request.
exposedHeaders String
The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
maxAgeInSeconds Number
The maximum amount time that a browser should cache the preflight OPTIONS request.

CreateMode
, CreateModeArgs

Default
Default
Restore
Restore
CreateModeDefault
Default
CreateModeRestore
Restore
Default
Default
Restore
Restore
Default
Default
Restore
Restore
DEFAULT
Default
RESTORE
Restore
"Default"
Default
"Restore"
Restore

DatabaseAccountKeysMetadataResponse
, DatabaseAccountKeysMetadataResponseArgs

PrimaryMasterKey This property is required. Pulumi.AzureNative.CosmosDB.Inputs.AccountKeyMetadataResponse
The metadata related to the Primary Read-Write Key for the given Cosmos DB database account.
PrimaryReadonlyMasterKey This property is required. Pulumi.AzureNative.CosmosDB.Inputs.AccountKeyMetadataResponse
The metadata related to the Primary Read-Only Key for the given Cosmos DB database account.
SecondaryMasterKey This property is required. Pulumi.AzureNative.CosmosDB.Inputs.AccountKeyMetadataResponse
The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account.
SecondaryReadonlyMasterKey This property is required. Pulumi.AzureNative.CosmosDB.Inputs.AccountKeyMetadataResponse
The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account.
PrimaryMasterKey This property is required. AccountKeyMetadataResponse
The metadata related to the Primary Read-Write Key for the given Cosmos DB database account.
PrimaryReadonlyMasterKey This property is required. AccountKeyMetadataResponse
The metadata related to the Primary Read-Only Key for the given Cosmos DB database account.
SecondaryMasterKey This property is required. AccountKeyMetadataResponse
The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account.
SecondaryReadonlyMasterKey This property is required. AccountKeyMetadataResponse
The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account.
primaryMasterKey This property is required. AccountKeyMetadataResponse
The metadata related to the Primary Read-Write Key for the given Cosmos DB database account.
primaryReadonlyMasterKey This property is required. AccountKeyMetadataResponse
The metadata related to the Primary Read-Only Key for the given Cosmos DB database account.
secondaryMasterKey This property is required. AccountKeyMetadataResponse
The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account.
secondaryReadonlyMasterKey This property is required. AccountKeyMetadataResponse
The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account.
primaryMasterKey This property is required. AccountKeyMetadataResponse
The metadata related to the Primary Read-Write Key for the given Cosmos DB database account.
primaryReadonlyMasterKey This property is required. AccountKeyMetadataResponse
The metadata related to the Primary Read-Only Key for the given Cosmos DB database account.
secondaryMasterKey This property is required. AccountKeyMetadataResponse
The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account.
secondaryReadonlyMasterKey This property is required. AccountKeyMetadataResponse
The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account.
primary_master_key This property is required. AccountKeyMetadataResponse
The metadata related to the Primary Read-Write Key for the given Cosmos DB database account.
primary_readonly_master_key This property is required. AccountKeyMetadataResponse
The metadata related to the Primary Read-Only Key for the given Cosmos DB database account.
secondary_master_key This property is required. AccountKeyMetadataResponse
The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account.
secondary_readonly_master_key This property is required. AccountKeyMetadataResponse
The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account.
primaryMasterKey This property is required. Property Map
The metadata related to the Primary Read-Write Key for the given Cosmos DB database account.
primaryReadonlyMasterKey This property is required. Property Map
The metadata related to the Primary Read-Only Key for the given Cosmos DB database account.
secondaryMasterKey This property is required. Property Map
The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account.
secondaryReadonlyMasterKey This property is required. Property Map
The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account.

DatabaseAccountKind
, DatabaseAccountKindArgs

GlobalDocumentDB
GlobalDocumentDB
MongoDB
MongoDB
Parse
Parse
DatabaseAccountKindGlobalDocumentDB
GlobalDocumentDB
DatabaseAccountKindMongoDB
MongoDB
DatabaseAccountKindParse
Parse
GlobalDocumentDB
GlobalDocumentDB
MongoDB
MongoDB
Parse
Parse
GlobalDocumentDB
GlobalDocumentDB
MongoDB
MongoDB
Parse
Parse
GLOBAL_DOCUMENT_DB
GlobalDocumentDB
MONGO_DB
MongoDB
PARSE
Parse
"GlobalDocumentDB"
GlobalDocumentDB
"MongoDB"
MongoDB
"Parse"
Parse

DatabaseAccountOfferType
, DatabaseAccountOfferTypeArgs

Standard
Standard
DatabaseAccountOfferTypeStandard
Standard
Standard
Standard
Standard
Standard
STANDARD
Standard
"Standard"
Standard

DatabaseRestoreResource
, DatabaseRestoreResourceArgs

CollectionNames List<string>
The names of the collections available for restore.
DatabaseName string
The name of the database available for restore.
CollectionNames []string
The names of the collections available for restore.
DatabaseName string
The name of the database available for restore.
collectionNames List<String>
The names of the collections available for restore.
databaseName String
The name of the database available for restore.
collectionNames string[]
The names of the collections available for restore.
databaseName string
The name of the database available for restore.
collection_names Sequence[str]
The names of the collections available for restore.
database_name str
The name of the database available for restore.
collectionNames List<String>
The names of the collections available for restore.
databaseName String
The name of the database available for restore.

DatabaseRestoreResourceResponse
, DatabaseRestoreResourceResponseArgs

CollectionNames List<string>
The names of the collections available for restore.
DatabaseName string
The name of the database available for restore.
CollectionNames []string
The names of the collections available for restore.
DatabaseName string
The name of the database available for restore.
collectionNames List<String>
The names of the collections available for restore.
databaseName String
The name of the database available for restore.
collectionNames string[]
The names of the collections available for restore.
databaseName string
The name of the database available for restore.
collection_names Sequence[str]
The names of the collections available for restore.
database_name str
The name of the database available for restore.
collectionNames List<String>
The names of the collections available for restore.
databaseName String
The name of the database available for restore.

DefaultConsistencyLevel
, DefaultConsistencyLevelArgs

Eventual
Eventual
Session
Session
BoundedStaleness
BoundedStaleness
Strong
Strong
ConsistentPrefix
ConsistentPrefix
DefaultConsistencyLevelEventual
Eventual
DefaultConsistencyLevelSession
Session
DefaultConsistencyLevelBoundedStaleness
BoundedStaleness
DefaultConsistencyLevelStrong
Strong
DefaultConsistencyLevelConsistentPrefix
ConsistentPrefix
Eventual
Eventual
Session
Session
BoundedStaleness
BoundedStaleness
Strong
Strong
ConsistentPrefix
ConsistentPrefix
Eventual
Eventual
Session
Session
BoundedStaleness
BoundedStaleness
Strong
Strong
ConsistentPrefix
ConsistentPrefix
EVENTUAL
Eventual
SESSION
Session
BOUNDED_STALENESS
BoundedStaleness
STRONG
Strong
CONSISTENT_PREFIX
ConsistentPrefix
"Eventual"
Eventual
"Session"
Session
"BoundedStaleness"
BoundedStaleness
"Strong"
Strong
"ConsistentPrefix"
ConsistentPrefix

FailoverPolicyResponse
, FailoverPolicyResponseArgs

Id This property is required. string
The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.
FailoverPriority int
The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
LocationName string
The name of the region in which the database account exists.
Id This property is required. string
The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.
FailoverPriority int
The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
LocationName string
The name of the region in which the database account exists.
id This property is required. String
The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.
failoverPriority Integer
The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
locationName String
The name of the region in which the database account exists.
id This property is required. string
The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.
failoverPriority number
The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
locationName string
The name of the region in which the database account exists.
id This property is required. str
The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.
failover_priority int
The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
location_name str
The name of the region in which the database account exists.
id This property is required. String
The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.
failoverPriority Number
The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
locationName String
The name of the region in which the database account exists.

GremlinDatabaseRestoreResource
, GremlinDatabaseRestoreResourceArgs

DatabaseName string
The name of the gremlin database available for restore.
GraphNames List<string>
The names of the graphs available for restore.
DatabaseName string
The name of the gremlin database available for restore.
GraphNames []string
The names of the graphs available for restore.
databaseName String
The name of the gremlin database available for restore.
graphNames List<String>
The names of the graphs available for restore.
databaseName string
The name of the gremlin database available for restore.
graphNames string[]
The names of the graphs available for restore.
database_name str
The name of the gremlin database available for restore.
graph_names Sequence[str]
The names of the graphs available for restore.
databaseName String
The name of the gremlin database available for restore.
graphNames List<String>
The names of the graphs available for restore.

GremlinDatabaseRestoreResourceResponse
, GremlinDatabaseRestoreResourceResponseArgs

DatabaseName string
The name of the gremlin database available for restore.
GraphNames List<string>
The names of the graphs available for restore.
DatabaseName string
The name of the gremlin database available for restore.
GraphNames []string
The names of the graphs available for restore.
databaseName String
The name of the gremlin database available for restore.
graphNames List<String>
The names of the graphs available for restore.
databaseName string
The name of the gremlin database available for restore.
graphNames string[]
The names of the graphs available for restore.
database_name str
The name of the gremlin database available for restore.
graph_names Sequence[str]
The names of the graphs available for restore.
databaseName String
The name of the gremlin database available for restore.
graphNames List<String>
The names of the graphs available for restore.

IpAddressOrRange
, IpAddressOrRangeArgs

IpAddressOrRange string
A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.
IpAddressOrRange string
A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.
ipAddressOrRange String
A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.
ipAddressOrRange string
A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.
ip_address_or_range str
A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.
ipAddressOrRange String
A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.

IpAddressOrRangeResponse
, IpAddressOrRangeResponseArgs

IpAddressOrRange string
A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.
IpAddressOrRange string
A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.
ipAddressOrRange String
A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.
ipAddressOrRange string
A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.
ip_address_or_range str
A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.
ipAddressOrRange String
A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.

Location
, LocationArgs

FailoverPriority int
The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
IsZoneRedundant bool
Flag to indicate whether or not this region is an AvailabilityZone region
LocationName string
The name of the region.
FailoverPriority int
The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
IsZoneRedundant bool
Flag to indicate whether or not this region is an AvailabilityZone region
LocationName string
The name of the region.
failoverPriority Integer
The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
isZoneRedundant Boolean
Flag to indicate whether or not this region is an AvailabilityZone region
locationName String
The name of the region.
failoverPriority number
The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
isZoneRedundant boolean
Flag to indicate whether or not this region is an AvailabilityZone region
locationName string
The name of the region.
failover_priority int
The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
is_zone_redundant bool
Flag to indicate whether or not this region is an AvailabilityZone region
location_name str
The name of the region.
failoverPriority Number
The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
isZoneRedundant Boolean
Flag to indicate whether or not this region is an AvailabilityZone region
locationName String
The name of the region.

LocationResponse
, LocationResponseArgs

DocumentEndpoint This property is required. string
The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/
Id This property is required. string
The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
ProvisioningState This property is required. string
The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.
FailoverPriority int
The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
IsZoneRedundant bool
Flag to indicate whether or not this region is an AvailabilityZone region
LocationName string
The name of the region.
DocumentEndpoint This property is required. string
The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/
Id This property is required. string
The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
ProvisioningState This property is required. string
The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.
FailoverPriority int
The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
IsZoneRedundant bool
Flag to indicate whether or not this region is an AvailabilityZone region
LocationName string
The name of the region.
documentEndpoint This property is required. String
The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/
id This property is required. String
The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
provisioningState This property is required. String
The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.
failoverPriority Integer
The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
isZoneRedundant Boolean
Flag to indicate whether or not this region is an AvailabilityZone region
locationName String
The name of the region.
documentEndpoint This property is required. string
The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/
id This property is required. string
The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
provisioningState This property is required. string
The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.
failoverPriority number
The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
isZoneRedundant boolean
Flag to indicate whether or not this region is an AvailabilityZone region
locationName string
The name of the region.
document_endpoint This property is required. str
The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/
id This property is required. str
The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
provisioning_state This property is required. str
The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.
failover_priority int
The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
is_zone_redundant bool
Flag to indicate whether or not this region is an AvailabilityZone region
location_name str
The name of the region.
documentEndpoint This property is required. String
The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/
id This property is required. String
The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
provisioningState This property is required. String
The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.
failoverPriority Number
The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
isZoneRedundant Boolean
Flag to indicate whether or not this region is an AvailabilityZone region
locationName String
The name of the region.

ManagedServiceIdentity
, ManagedServiceIdentityArgs

Type Pulumi.AzureNative.CosmosDB.ResourceIdentityType
The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
UserAssignedIdentities List<string>
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Type ResourceIdentityType
The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
UserAssignedIdentities []string
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
type ResourceIdentityType
The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
userAssignedIdentities List<String>
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
type ResourceIdentityType
The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
userAssignedIdentities string[]
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
type ResourceIdentityType
The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
user_assigned_identities Sequence[str]
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
type "SystemAssigned" | "UserAssigned" | "SystemAssigned,UserAssigned" | "None"
The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
userAssignedIdentities List<String>
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ManagedServiceIdentityResponse
, ManagedServiceIdentityResponseArgs

PrincipalId This property is required. string
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
Type string
The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.CosmosDB.Inputs.ManagedServiceIdentityResponseUserAssignedIdentities>
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
PrincipalId This property is required. string
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
Type string
The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
UserAssignedIdentities map[string]ManagedServiceIdentityResponseUserAssignedIdentities
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principalId This property is required. String
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
type String
The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
userAssignedIdentities Map<String,ManagedServiceIdentityResponseUserAssignedIdentities>
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principalId This property is required. string
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. string
The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
type string
The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
userAssignedIdentities {[key: string]: ManagedServiceIdentityResponseUserAssignedIdentities}
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principal_id This property is required. str
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id This property is required. str
The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
type str
The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
user_assigned_identities Mapping[str, ManagedServiceIdentityResponseUserAssignedIdentities]
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principalId This property is required. String
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
type String
The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
userAssignedIdentities Map<Property Map>
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ManagedServiceIdentityResponseUserAssignedIdentities
, ManagedServiceIdentityResponseUserAssignedIdentitiesArgs

ClientId This property is required. string
The client id of user assigned identity.
PrincipalId This property is required. string
The principal id of user assigned identity.
ClientId This property is required. string
The client id of user assigned identity.
PrincipalId This property is required. string
The principal id of user assigned identity.
clientId This property is required. String
The client id of user assigned identity.
principalId This property is required. String
The principal id of user assigned identity.
clientId This property is required. string
The client id of user assigned identity.
principalId This property is required. string
The principal id of user assigned identity.
client_id This property is required. str
The client id of user assigned identity.
principal_id This property is required. str
The principal id of user assigned identity.
clientId This property is required. String
The client id of user assigned identity.
principalId This property is required. String
The principal id of user assigned identity.

MinimalTlsVersion
, MinimalTlsVersionArgs

Tls
Tls
Tls11
Tls11
Tls12
Tls12
MinimalTlsVersionTls
Tls
MinimalTlsVersionTls11
Tls11
MinimalTlsVersionTls12
Tls12
Tls
Tls
Tls11
Tls11
Tls12
Tls12
Tls
Tls
Tls11
Tls11
Tls12
Tls12
TLS
Tls
TLS11
Tls11
TLS12
Tls12
"Tls"
Tls
"Tls11"
Tls11
"Tls12"
Tls12

NetworkAclBypass
, NetworkAclBypassArgs

None
None
AzureServices
AzureServices
NetworkAclBypassNone
None
NetworkAclBypassAzureServices
AzureServices
None
None
AzureServices
AzureServices
None
None
AzureServices
AzureServices
NONE
None
AZURE_SERVICES
AzureServices
"None"
None
"AzureServices"
AzureServices

PeriodicModeBackupPolicy
, PeriodicModeBackupPolicyArgs

MigrationState Pulumi.AzureNative.CosmosDB.Inputs.BackupPolicyMigrationState
The object representing the state of the migration between the backup policies.
PeriodicModeProperties Pulumi.AzureNative.CosmosDB.Inputs.PeriodicModeProperties
Configuration values for periodic mode backup
MigrationState BackupPolicyMigrationState
The object representing the state of the migration between the backup policies.
PeriodicModeProperties PeriodicModeProperties
Configuration values for periodic mode backup
migrationState BackupPolicyMigrationState
The object representing the state of the migration between the backup policies.
periodicModeProperties PeriodicModeProperties
Configuration values for periodic mode backup
migrationState BackupPolicyMigrationState
The object representing the state of the migration between the backup policies.
periodicModeProperties PeriodicModeProperties
Configuration values for periodic mode backup
migration_state BackupPolicyMigrationState
The object representing the state of the migration between the backup policies.
periodic_mode_properties PeriodicModeProperties
Configuration values for periodic mode backup
migrationState Property Map
The object representing the state of the migration between the backup policies.
periodicModeProperties Property Map
Configuration values for periodic mode backup

PeriodicModeBackupPolicyResponse
, PeriodicModeBackupPolicyResponseArgs

MigrationState Pulumi.AzureNative.CosmosDB.Inputs.BackupPolicyMigrationStateResponse
The object representing the state of the migration between the backup policies.
PeriodicModeProperties Pulumi.AzureNative.CosmosDB.Inputs.PeriodicModePropertiesResponse
Configuration values for periodic mode backup
MigrationState BackupPolicyMigrationStateResponse
The object representing the state of the migration between the backup policies.
PeriodicModeProperties PeriodicModePropertiesResponse
Configuration values for periodic mode backup
migrationState BackupPolicyMigrationStateResponse
The object representing the state of the migration between the backup policies.
periodicModeProperties PeriodicModePropertiesResponse
Configuration values for periodic mode backup
migrationState BackupPolicyMigrationStateResponse
The object representing the state of the migration between the backup policies.
periodicModeProperties PeriodicModePropertiesResponse
Configuration values for periodic mode backup
migration_state BackupPolicyMigrationStateResponse
The object representing the state of the migration between the backup policies.
periodic_mode_properties PeriodicModePropertiesResponse
Configuration values for periodic mode backup
migrationState Property Map
The object representing the state of the migration between the backup policies.
periodicModeProperties Property Map
Configuration values for periodic mode backup

PeriodicModeProperties
, PeriodicModePropertiesArgs

BackupIntervalInMinutes int
An integer representing the interval in minutes between two backups
BackupRetentionIntervalInHours int
An integer representing the time (in hours) that each backup is retained
BackupStorageRedundancy string | Pulumi.AzureNative.CosmosDB.BackupStorageRedundancy
Enum to indicate type of backup residency
BackupIntervalInMinutes int
An integer representing the interval in minutes between two backups
BackupRetentionIntervalInHours int
An integer representing the time (in hours) that each backup is retained
BackupStorageRedundancy string | BackupStorageRedundancy
Enum to indicate type of backup residency
backupIntervalInMinutes Integer
An integer representing the interval in minutes between two backups
backupRetentionIntervalInHours Integer
An integer representing the time (in hours) that each backup is retained
backupStorageRedundancy String | BackupStorageRedundancy
Enum to indicate type of backup residency
backupIntervalInMinutes number
An integer representing the interval in minutes between two backups
backupRetentionIntervalInHours number
An integer representing the time (in hours) that each backup is retained
backupStorageRedundancy string | BackupStorageRedundancy
Enum to indicate type of backup residency
backup_interval_in_minutes int
An integer representing the interval in minutes between two backups
backup_retention_interval_in_hours int
An integer representing the time (in hours) that each backup is retained
backup_storage_redundancy str | BackupStorageRedundancy
Enum to indicate type of backup residency
backupIntervalInMinutes Number
An integer representing the interval in minutes between two backups
backupRetentionIntervalInHours Number
An integer representing the time (in hours) that each backup is retained
backupStorageRedundancy String | "Geo" | "Local" | "Zone"
Enum to indicate type of backup residency

PeriodicModePropertiesResponse
, PeriodicModePropertiesResponseArgs

BackupIntervalInMinutes int
An integer representing the interval in minutes between two backups
BackupRetentionIntervalInHours int
An integer representing the time (in hours) that each backup is retained
BackupStorageRedundancy string
Enum to indicate type of backup residency
BackupIntervalInMinutes int
An integer representing the interval in minutes between two backups
BackupRetentionIntervalInHours int
An integer representing the time (in hours) that each backup is retained
BackupStorageRedundancy string
Enum to indicate type of backup residency
backupIntervalInMinutes Integer
An integer representing the interval in minutes between two backups
backupRetentionIntervalInHours Integer
An integer representing the time (in hours) that each backup is retained
backupStorageRedundancy String
Enum to indicate type of backup residency
backupIntervalInMinutes number
An integer representing the interval in minutes between two backups
backupRetentionIntervalInHours number
An integer representing the time (in hours) that each backup is retained
backupStorageRedundancy string
Enum to indicate type of backup residency
backup_interval_in_minutes int
An integer representing the interval in minutes between two backups
backup_retention_interval_in_hours int
An integer representing the time (in hours) that each backup is retained
backup_storage_redundancy str
Enum to indicate type of backup residency
backupIntervalInMinutes Number
An integer representing the interval in minutes between two backups
backupRetentionIntervalInHours Number
An integer representing the time (in hours) that each backup is retained
backupStorageRedundancy String
Enum to indicate type of backup residency

PrivateEndpointConnectionResponse
, PrivateEndpointConnectionResponseArgs

Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name This property is required. string
The name of the resource
Type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
GroupId string
Group id of the private endpoint.
PrivateEndpoint Pulumi.AzureNative.CosmosDB.Inputs.PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState Pulumi.AzureNative.CosmosDB.Inputs.PrivateLinkServiceConnectionStatePropertyResponse
Connection State of the Private Endpoint Connection.
ProvisioningState string
Provisioning state of the private endpoint.
Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name This property is required. string
The name of the resource
Type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
GroupId string
Group id of the private endpoint.
PrivateEndpoint PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
Connection State of the Private Endpoint Connection.
ProvisioningState string
Provisioning state of the private endpoint.
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. String
The name of the resource
type This property is required. String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
groupId String
Group id of the private endpoint.
privateEndpoint PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
Connection State of the Private Endpoint Connection.
provisioningState String
Provisioning state of the private endpoint.
id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. string
The name of the resource
type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
groupId string
Group id of the private endpoint.
privateEndpoint PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
Connection State of the Private Endpoint Connection.
provisioningState string
Provisioning state of the private endpoint.
id This property is required. str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. str
The name of the resource
type This property is required. str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
group_id str
Group id of the private endpoint.
private_endpoint PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
private_link_service_connection_state PrivateLinkServiceConnectionStatePropertyResponse
Connection State of the Private Endpoint Connection.
provisioning_state str
Provisioning state of the private endpoint.
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. String
The name of the resource
type This property is required. String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
groupId String
Group id of the private endpoint.
privateEndpoint Property Map
Private endpoint which the connection belongs to.
privateLinkServiceConnectionState Property Map
Connection State of the Private Endpoint Connection.
provisioningState String
Provisioning state of the private endpoint.

PrivateEndpointPropertyResponse
, PrivateEndpointPropertyResponseArgs

Id string
Resource id of the private endpoint.
Id string
Resource id of the private endpoint.
id String
Resource id of the private endpoint.
id string
Resource id of the private endpoint.
id str
Resource id of the private endpoint.
id String
Resource id of the private endpoint.

PrivateLinkServiceConnectionStatePropertyResponse
, PrivateLinkServiceConnectionStatePropertyResponseArgs

ActionsRequired This property is required. string
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
Description string
The private link service connection description.
Status string
The private link service connection status.
ActionsRequired This property is required. string
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
Description string
The private link service connection description.
Status string
The private link service connection status.
actionsRequired This property is required. String
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
description String
The private link service connection description.
status String
The private link service connection status.
actionsRequired This property is required. string
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
description string
The private link service connection description.
status string
The private link service connection status.
actions_required This property is required. str
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
description str
The private link service connection description.
status str
The private link service connection status.
actionsRequired This property is required. String
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
description String
The private link service connection description.
status String
The private link service connection status.

PublicNetworkAccess
, PublicNetworkAccessArgs

Enabled
Enabled
Disabled
Disabled
SecuredByPerimeter
SecuredByPerimeter
PublicNetworkAccessEnabled
Enabled
PublicNetworkAccessDisabled
Disabled
PublicNetworkAccessSecuredByPerimeter
SecuredByPerimeter
Enabled
Enabled
Disabled
Disabled
SecuredByPerimeter
SecuredByPerimeter
Enabled
Enabled
Disabled
Disabled
SecuredByPerimeter
SecuredByPerimeter
ENABLED
Enabled
DISABLED
Disabled
SECURED_BY_PERIMETER
SecuredByPerimeter
"Enabled"
Enabled
"Disabled"
Disabled
"SecuredByPerimeter"
SecuredByPerimeter

ResourceIdentityType
, ResourceIdentityTypeArgs

SystemAssigned
SystemAssigned
UserAssigned
UserAssigned
SystemAssigned_UserAssigned
SystemAssigned,UserAssigned
None
None
ResourceIdentityTypeSystemAssigned
SystemAssigned
ResourceIdentityTypeUserAssigned
UserAssigned
ResourceIdentityType_SystemAssigned_UserAssigned
SystemAssigned,UserAssigned
ResourceIdentityTypeNone
None
SystemAssigned
SystemAssigned
UserAssigned
UserAssigned
SystemAssigned_UserAssigned
SystemAssigned,UserAssigned
None
None
SystemAssigned
SystemAssigned
UserAssigned
UserAssigned
SystemAssigned_UserAssigned
SystemAssigned,UserAssigned
None
None
SYSTEM_ASSIGNED
SystemAssigned
USER_ASSIGNED
UserAssigned
SYSTEM_ASSIGNED_USER_ASSIGNED
SystemAssigned,UserAssigned
NONE
None
"SystemAssigned"
SystemAssigned
"UserAssigned"
UserAssigned
"SystemAssigned,UserAssigned"
SystemAssigned,UserAssigned
"None"
None

RestoreMode
, RestoreModeArgs

PointInTime
PointInTime
RestoreModePointInTime
PointInTime
PointInTime
PointInTime
PointInTime
PointInTime
POINT_IN_TIME
PointInTime
"PointInTime"
PointInTime

RestoreParameters
, RestoreParametersArgs

DatabasesToRestore List<Pulumi.AzureNative.CosmosDB.Inputs.DatabaseRestoreResource>
List of specific databases available for restore.
GremlinDatabasesToRestore List<Pulumi.AzureNative.CosmosDB.Inputs.GremlinDatabaseRestoreResource>
List of specific gremlin databases available for restore.
RestoreMode string | Pulumi.AzureNative.CosmosDB.RestoreMode
Describes the mode of the restore.
RestoreSource string
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
RestoreTimestampInUtc string
Time to which the account has to be restored (ISO-8601 format).
RestoreWithTtlDisabled bool
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
TablesToRestore List<string>
List of specific tables available for restore.
DatabasesToRestore []DatabaseRestoreResource
List of specific databases available for restore.
GremlinDatabasesToRestore []GremlinDatabaseRestoreResource
List of specific gremlin databases available for restore.
RestoreMode string | RestoreMode
Describes the mode of the restore.
RestoreSource string
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
RestoreTimestampInUtc string
Time to which the account has to be restored (ISO-8601 format).
RestoreWithTtlDisabled bool
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
TablesToRestore []string
List of specific tables available for restore.
databasesToRestore List<DatabaseRestoreResource>
List of specific databases available for restore.
gremlinDatabasesToRestore List<GremlinDatabaseRestoreResource>
List of specific gremlin databases available for restore.
restoreMode String | RestoreMode
Describes the mode of the restore.
restoreSource String
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc String
Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled Boolean
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
tablesToRestore List<String>
List of specific tables available for restore.
databasesToRestore DatabaseRestoreResource[]
List of specific databases available for restore.
gremlinDatabasesToRestore GremlinDatabaseRestoreResource[]
List of specific gremlin databases available for restore.
restoreMode string | RestoreMode
Describes the mode of the restore.
restoreSource string
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc string
Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled boolean
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
tablesToRestore string[]
List of specific tables available for restore.
databases_to_restore Sequence[DatabaseRestoreResource]
List of specific databases available for restore.
gremlin_databases_to_restore Sequence[GremlinDatabaseRestoreResource]
List of specific gremlin databases available for restore.
restore_mode str | RestoreMode
Describes the mode of the restore.
restore_source str
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restore_timestamp_in_utc str
Time to which the account has to be restored (ISO-8601 format).
restore_with_ttl_disabled bool
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
tables_to_restore Sequence[str]
List of specific tables available for restore.
databasesToRestore List<Property Map>
List of specific databases available for restore.
gremlinDatabasesToRestore List<Property Map>
List of specific gremlin databases available for restore.
restoreMode String | "PointInTime"
Describes the mode of the restore.
restoreSource String
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc String
Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled Boolean
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
tablesToRestore List<String>
List of specific tables available for restore.

RestoreParametersResponse
, RestoreParametersResponseArgs

DatabasesToRestore List<Pulumi.AzureNative.CosmosDB.Inputs.DatabaseRestoreResourceResponse>
List of specific databases available for restore.
GremlinDatabasesToRestore List<Pulumi.AzureNative.CosmosDB.Inputs.GremlinDatabaseRestoreResourceResponse>
List of specific gremlin databases available for restore.
RestoreMode string
Describes the mode of the restore.
RestoreSource string
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
RestoreTimestampInUtc string
Time to which the account has to be restored (ISO-8601 format).
RestoreWithTtlDisabled bool
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
TablesToRestore List<string>
List of specific tables available for restore.
DatabasesToRestore []DatabaseRestoreResourceResponse
List of specific databases available for restore.
GremlinDatabasesToRestore []GremlinDatabaseRestoreResourceResponse
List of specific gremlin databases available for restore.
RestoreMode string
Describes the mode of the restore.
RestoreSource string
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
RestoreTimestampInUtc string
Time to which the account has to be restored (ISO-8601 format).
RestoreWithTtlDisabled bool
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
TablesToRestore []string
List of specific tables available for restore.
databasesToRestore List<DatabaseRestoreResourceResponse>
List of specific databases available for restore.
gremlinDatabasesToRestore List<GremlinDatabaseRestoreResourceResponse>
List of specific gremlin databases available for restore.
restoreMode String
Describes the mode of the restore.
restoreSource String
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc String
Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled Boolean
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
tablesToRestore List<String>
List of specific tables available for restore.
databasesToRestore DatabaseRestoreResourceResponse[]
List of specific databases available for restore.
gremlinDatabasesToRestore GremlinDatabaseRestoreResourceResponse[]
List of specific gremlin databases available for restore.
restoreMode string
Describes the mode of the restore.
restoreSource string
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc string
Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled boolean
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
tablesToRestore string[]
List of specific tables available for restore.
databases_to_restore Sequence[DatabaseRestoreResourceResponse]
List of specific databases available for restore.
gremlin_databases_to_restore Sequence[GremlinDatabaseRestoreResourceResponse]
List of specific gremlin databases available for restore.
restore_mode str
Describes the mode of the restore.
restore_source str
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restore_timestamp_in_utc str
Time to which the account has to be restored (ISO-8601 format).
restore_with_ttl_disabled bool
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
tables_to_restore Sequence[str]
List of specific tables available for restore.
databasesToRestore List<Property Map>
List of specific databases available for restore.
gremlinDatabasesToRestore List<Property Map>
List of specific gremlin databases available for restore.
restoreMode String
Describes the mode of the restore.
restoreSource String
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc String
Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled Boolean
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
tablesToRestore List<String>
List of specific tables available for restore.

ServerVersion
, ServerVersionArgs

ServerVersion_3_2
3.2
ServerVersion_3_6
3.6
ServerVersion_4_0
4.0
ServerVersion_4_2
4.2
ServerVersion_5_0
5.0
ServerVersion_6_0
6.0
ServerVersion_7_0
7.0
ServerVersion_3_2
3.2
ServerVersion_3_6
3.6
ServerVersion_4_0
4.0
ServerVersion_4_2
4.2
ServerVersion_5_0
5.0
ServerVersion_6_0
6.0
ServerVersion_7_0
7.0
_3_2
3.2
_3_6
3.6
_4_0
4.0
_4_2
4.2
_5_0
5.0
_6_0
6.0
_7_0
7.0
ServerVersion_3_2
3.2
ServerVersion_3_6
3.6
ServerVersion_4_0
4.0
ServerVersion_4_2
4.2
ServerVersion_5_0
5.0
ServerVersion_6_0
6.0
ServerVersion_7_0
7.0
SERVER_VERSION_3_2
3.2
SERVER_VERSION_3_6
3.6
SERVER_VERSION_4_0
4.0
SERVER_VERSION_4_2
4.2
SERVER_VERSION_5_0
5.0
SERVER_VERSION_6_0
6.0
SERVER_VERSION_7_0
7.0
"3.2"
3.2
"3.6"
3.6
"4.0"
4.0
"4.2"
4.2
"5.0"
5.0
"6.0"
6.0
"7.0"
7.0

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

VirtualNetworkRule
, VirtualNetworkRuleArgs

Id string
Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
IgnoreMissingVNetServiceEndpoint bool
Create firewall rule before the virtual network has vnet service endpoint enabled.
Id string
Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
IgnoreMissingVNetServiceEndpoint bool
Create firewall rule before the virtual network has vnet service endpoint enabled.
id String
Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignoreMissingVNetServiceEndpoint Boolean
Create firewall rule before the virtual network has vnet service endpoint enabled.
id string
Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignoreMissingVNetServiceEndpoint boolean
Create firewall rule before the virtual network has vnet service endpoint enabled.
id str
Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignore_missing_v_net_service_endpoint bool
Create firewall rule before the virtual network has vnet service endpoint enabled.
id String
Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignoreMissingVNetServiceEndpoint Boolean
Create firewall rule before the virtual network has vnet service endpoint enabled.

VirtualNetworkRuleResponse
, VirtualNetworkRuleResponseArgs

Id string
Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
IgnoreMissingVNetServiceEndpoint bool
Create firewall rule before the virtual network has vnet service endpoint enabled.
Id string
Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
IgnoreMissingVNetServiceEndpoint bool
Create firewall rule before the virtual network has vnet service endpoint enabled.
id String
Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignoreMissingVNetServiceEndpoint Boolean
Create firewall rule before the virtual network has vnet service endpoint enabled.
id string
Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignoreMissingVNetServiceEndpoint boolean
Create firewall rule before the virtual network has vnet service endpoint enabled.
id str
Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignore_missing_v_net_service_endpoint bool
Create firewall rule before the virtual network has vnet service endpoint enabled.
id String
Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignoreMissingVNetServiceEndpoint Boolean
Create firewall rule before the virtual network has vnet service endpoint enabled.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:cosmosdb:DatabaseAccount ddb1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native