cosmosdb

Documentation

Index

• type Account
  • func GetAccount(ctx *pulumi.Context, name string, id pulumi.ID, state *AccountState, ...) (*Account, error)
  • func NewAccount(ctx *pulumi.Context, name string, args *AccountArgs, ...) (*Account, error)
  • func (r *Account) ConnectionStrings() *pulumi.ArrayOutput
  • func (r *Account) ConsistencyPolicy() *pulumi.Output
  • func (r *Account) EnableAutomaticFailover() *pulumi.BoolOutput
  • func (r *Account) Endpoint() *pulumi.StringOutput
  • func (r *Account) FailoverPolicies() *pulumi.ArrayOutput
  • func (r *Account) GeoLocations() *pulumi.ArrayOutput
  • func (r *Account) ID() *pulumi.IDOutput
  • func (r *Account) IpRangeFilter() *pulumi.StringOutput
  • func (r *Account) Kind() *pulumi.StringOutput
  • func (r *Account) Location() *pulumi.StringOutput
  • func (r *Account) Name() *pulumi.StringOutput
  • func (r *Account) OfferType() *pulumi.StringOutput
  • func (r *Account) PrimaryMasterKey() *pulumi.StringOutput
  • func (r *Account) PrimaryReadonlyMasterKey() *pulumi.StringOutput
  • func (r *Account) ReadEndpoints() *pulumi.ArrayOutput
  • func (r *Account) ResourceGroupName() *pulumi.StringOutput
  • func (r *Account) SecondaryMasterKey() *pulumi.StringOutput
  • func (r *Account) SecondaryReadonlyMasterKey() *pulumi.StringOutput
  • func (r *Account) Tags() *pulumi.MapOutput
  • func (r *Account) URN() *pulumi.URNOutput
  • func (r *Account) WriteEndpoints() *pulumi.ArrayOutput
• type AccountArgs
• type AccountState
• type GetAccountArgs
• type GetAccountResult
  • func LookupAccount(ctx *pulumi.Context, args *GetAccountArgs) (*GetAccountResult, error)

Types

type Account

type Account struct {
	// contains filtered or unexported fields
}

Manages a new CosmosDB (formally DocumentDB) Account.

func GetAccount

func GetAccount(ctx *pulumi.Context,
	name string, id pulumi.ID, state *AccountState, opts ...pulumi.ResourceOpt) (*Account, error)

GetAccount gets an existing Account resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAccount

func NewAccount(ctx *pulumi.Context,
	name string, args *AccountArgs, opts ...pulumi.ResourceOpt) (*Account, error)

NewAccount registers a new resource with the given unique name, arguments, and options.

func (*Account) ConnectionStrings

func (r *Account) ConnectionStrings() *pulumi.ArrayOutput

A list of connection strings available for this CosmosDB account. If the kind is `GlobalDocumentDB`, this will be empty.

func (*Account) ConsistencyPolicy

func (r *Account) ConsistencyPolicy() *pulumi.Output

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

func (*Account) EnableAutomaticFailover

func (r *Account) EnableAutomaticFailover() *pulumi.BoolOutput

Enable automatic fail over for this Cosmos DB account.

func (*Account) Endpoint

func (r *Account) Endpoint() *pulumi.StringOutput

The endpoint used to connect to the CosmosDB account.

func (*Account) FailoverPolicies

func (r *Account) FailoverPolicies() *pulumi.ArrayOutput

func (*Account) GeoLocations

func (r *Account) GeoLocations() *pulumi.ArrayOutput

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

func (*Account) ID

func (r *Account) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Account) IpRangeFilter

func (r *Account) IpRangeFilter() *pulumi.StringOutput

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.

func (*Account) Kind

func (r *Account) Kind() *pulumi.StringOutput

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.

func (*Account) Location

func (r *Account) Location() *pulumi.StringOutput

The name of the Azure region to host replicated data.

func (*Account) Name

func (r *Account) Name() *pulumi.StringOutput

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

func (*Account) OfferType

func (r *Account) OfferType() *pulumi.StringOutput

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

func (*Account) PrimaryMasterKey

func (r *Account) PrimaryMasterKey() *pulumi.StringOutput

The Primary master key for the CosmosDB Account.

func (*Account) PrimaryReadonlyMasterKey

func (r *Account) PrimaryReadonlyMasterKey() *pulumi.StringOutput

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

func (*Account) ReadEndpoints

func (r *Account) ReadEndpoints() *pulumi.ArrayOutput

A list of read endpoints available for this CosmosDB account.

func (*Account) ResourceGroupName

func (r *Account) ResourceGroupName() *pulumi.StringOutput

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

func (*Account) SecondaryMasterKey

func (r *Account) SecondaryMasterKey() *pulumi.StringOutput

The Secondary master key for the CosmosDB Account.

func (*Account) SecondaryReadonlyMasterKey

func (r *Account) SecondaryReadonlyMasterKey() *pulumi.StringOutput

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

func (*Account) Tags

func (r *Account) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*Account) URN

func (r *Account) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*Account) WriteEndpoints

func (r *Account) WriteEndpoints() *pulumi.ArrayOutput

A list of write endpoints available for this CosmosDB account.

type AccountArgs

type AccountArgs struct {
	// Specifies a `consistency_policy` resource, used to define the consistency policy for this CosmosDB account.
	ConsistencyPolicy interface{}
	// Enable automatic fail over for this Cosmos DB account.
	EnableAutomaticFailover interface{}
	FailoverPolicies        interface{}
	// Specifies a `geo_location` resource, used to define where data should be replicated with the `failover_priority` 0 specifying the primary location.
	GeoLocations interface{}
	// 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.
	IpRangeFilter interface{}
	// 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.
	Kind interface{}
	// The name of the Azure region to host replicated data.
	Location interface{}
	// Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
	Name interface{}
	// Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to `Standard`.
	OfferType interface{}
	// The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

The set of arguments for constructing a Account resource.

type AccountState

type AccountState struct {
	// A list of connection strings available for this CosmosDB account. If the kind is `GlobalDocumentDB`, this will be empty.
	ConnectionStrings interface{}
	// Specifies a `consistency_policy` resource, used to define the consistency policy for this CosmosDB account.
	ConsistencyPolicy interface{}
	// Enable automatic fail over for this Cosmos DB account.
	EnableAutomaticFailover interface{}
	// The endpoint used to connect to the CosmosDB account.
	Endpoint         interface{}
	FailoverPolicies interface{}
	// Specifies a `geo_location` resource, used to define where data should be replicated with the `failover_priority` 0 specifying the primary location.
	GeoLocations interface{}
	// 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.
	IpRangeFilter interface{}
	// 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.
	Kind interface{}
	// The name of the Azure region to host replicated data.
	Location interface{}
	// Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.
	Name interface{}
	// Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to `Standard`.
	OfferType interface{}
	// The Primary master key for the CosmosDB Account.
	PrimaryMasterKey interface{}
	// The Primary read-only master Key for the CosmosDB Account.
	PrimaryReadonlyMasterKey interface{}
	// A list of read endpoints available for this CosmosDB account.
	ReadEndpoints interface{}
	// The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// The Secondary master key for the CosmosDB Account.
	SecondaryMasterKey interface{}
	// The Secondary read-only master key for the CosmosDB Account.
	SecondaryReadonlyMasterKey interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
	// A list of write endpoints available for this CosmosDB account.
	WriteEndpoints interface{}
}

Input properties used for looking up and filtering Account resources.

type GetAccountArgs

type GetAccountArgs struct {
	// Specifies the name of the CosmosDB Account.
	Name interface{}
	// Specifies the name of the resource group in which the CosmosDB Account resides.
	ResourceGroupName interface{}
}

A collection of arguments for invoking getAccount.

type GetAccountResult

type GetAccountResult struct {
	ConsistencyPolicies interface{}
	// If automatic failover is enabled for this CosmosDB Account.
	EnableAutomaticFailover interface{}
	// The endpoint used to connect to the CosmosDB account.
	Endpoint     interface{}
	GeoLocations interface{}
	// The current IP Filter for this CosmosDB account
	IpRangeFilter interface{}
	// The Kind of the CosmosDB account.
	Kind interface{}
	// The name of the Azure region hosting replicated data.
	Location interface{}
	// The Offer Type to used by this CosmosDB Account.
	OfferType interface{}
	// The Primary master key for the CosmosDB Account.
	PrimaryMasterKey interface{}
	// The Primary read-only master Key for the CosmosDB Account.
	PrimaryReadonlyMasterKey interface{}
	// A list of read endpoints available for this CosmosDB account.
	ReadEndpoints interface{}
	// The Secondary master key for the CosmosDB Account.
	SecondaryMasterKey interface{}
	// The Secondary read-only master key for the CosmosDB Account.
	SecondaryReadonlyMasterKey interface{}
	// A mapping of tags assigned to the resource.
	Tags interface{}
	// A list of write endpoints available for this CosmosDB account.
	WriteEndpoints interface{}
}

A collection of values returned by getAccount.

func LookupAccount

func LookupAccount(ctx *pulumi.Context, args *GetAccountArgs) (*GetAccountResult, error)

Use this data source to access the properties of an Azure CosmosDB (formally DocumentDB) Account.