Class Account

Manages a CosmosDB (formally DocumentDB) Account.

Inheritance

System.Object

Resource

CustomResource

Account

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.CosmosDB

Assembly: Pulumi.Azure.dll

Syntax

public class Account : CustomResource

Constructors

Account(String, AccountArgs, CustomResourceOptions)

Create a Account resource with the given unique name, arguments, and options.

Declaration

public Account(string name, AccountArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
AccountArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Capabilities

The capabilities which should be enabled for this Cosmos DB account. Possible values are EnableAggregationPipeline, EnableCassandra, EnableGremlin, EnableTable, MongoDBv3.4, and mongoEnableDocLevelTTL.

Declaration

public Output<ImmutableArray<AccountCapability>> Capabilities { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<AccountCapability>>

ConnectionStrings

A list of connection strings available for this CosmosDB account.

Declaration

public Output<ImmutableArray<string>> ConnectionStrings { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

ConsistencyPolicy

Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.

Declaration

public Output<AccountConsistencyPolicy> ConsistencyPolicy { get; }

Property Value

Type	Description
Output<AccountConsistencyPolicy>

EnableAutomaticFailover

Enable automatic fail over for this Cosmos DB account.

Declaration

public Output<bool?> EnableAutomaticFailover { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

EnableMultipleWriteLocations

Enable multi-master support for this Cosmos DB account.

Declaration

public Output<bool?> EnableMultipleWriteLocations { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Endpoint

The endpoint used to connect to the CosmosDB account.

Declaration

public Output<string> Endpoint { get; }

Property Value

Type	Description
Output<System.String>

GeoLocations

Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location.

Declaration

public Output<ImmutableArray<AccountGeoLocation>> GeoLocations { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<AccountGeoLocation>>

IpRangeFilter

CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP's for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.

Declaration

public Output<string> IpRangeFilter { get; }

Property Value

Type	Description
Output<System.String>

IsVirtualNetworkFilterEnabled

Enables virtual network filtering for this Cosmos DB account.

Declaration

public Output<bool?> IsVirtualNetworkFilterEnabled { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Kind

Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.

Declaration

public Output<string> Kind { get; }

Property Value

Type	Description
Output<System.String>

Location

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

Name

Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

OfferType

Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.

Declaration

public Output<string> OfferType { get; }

Property Value

Type	Description
Output<System.String>

PrimaryMasterKey

The Primary master key for the CosmosDB Account.

Declaration

public Output<string> PrimaryMasterKey { get; }

Property Value

Type	Description
Output<System.String>

PrimaryReadonlyMasterKey

The Primary read-only master Key for the CosmosDB Account.

Declaration

public Output<string> PrimaryReadonlyMasterKey { get; }

Property Value

Type	Description
Output<System.String>

ReadEndpoints

A list of read endpoints available for this CosmosDB account.

Declaration

public Output<ImmutableArray<string>> ReadEndpoints { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

ResourceGroupName

The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

SecondaryMasterKey

The Secondary master key for the CosmosDB Account.

Declaration

public Output<string> SecondaryMasterKey { get; }

Property Value

Type	Description
Output<System.String>

SecondaryReadonlyMasterKey

The Secondary read-only master key for the CosmosDB Account.

Declaration

public Output<string> SecondaryReadonlyMasterKey { get; }

Property Value

Type	Description
Output<System.String>

Tags

A mapping of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, string>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

VirtualNetworkRules

Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.

Declaration

public Output<ImmutableArray<AccountVirtualNetworkRule>> VirtualNetworkRules { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<AccountVirtualNetworkRule>>

WriteEndpoints

A list of write endpoints available for this CosmosDB account.

Declaration

public Output<ImmutableArray<string>> WriteEndpoints { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Methods

Get(String, Input<String>, AccountState, CustomResourceOptions)

Get an existing Account resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Account Get(string name, Input<string> id, AccountState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
AccountState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Account