cosmosdb

package
v0.16.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 5, 2018 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Account 

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

Manages a 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) Capabilities added in v0.15.0 

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

Enable capabilities for this Cosmos DB account. Possible values are `EnableTable` and `EnableGremlin`.

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) EnableMultipleWriteLocations added in v0.16.5 

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

Enable multi-master support 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) IsVirtualNetworkFilterEnabled added in v0.16.0 

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

Enables virtual network filtering for this Cosmos DB account.

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) VirtualNetworkRules added in v0.16.0 

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

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

func (*Account) WriteEndpoints 

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

A list of write endpoints available for this CosmosDB account.

type AccountArgs 

type AccountArgs struct {
	// Enable capabilities for this Cosmos DB account. Possible values are `EnableTable` and `EnableGremlin`.
	Capabilities 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{}
	// Enable multi-master support for this Cosmos DB account.
	EnableMultipleWriteLocations 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{}
	// Enables virtual network filtering for this Cosmos DB account.
	IsVirtualNetworkFilterEnabled 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{}
	// Specifies a `virtual_network_rules` resource, used to define which subnets are allowed to access this CosmosDB account.
	VirtualNetworkRules interface{}
}

The set of arguments for constructing a Account resource.

type AccountState 

type AccountState struct {
	// Enable capabilities for this Cosmos DB account. Possible values are `EnableTable` and `EnableGremlin`.
	Capabilities interface{}
	// 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{}
	// Enable multi-master support for this Cosmos DB account.
	EnableMultipleWriteLocations 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{}
	// Enables virtual network filtering for this Cosmos DB account.
	IsVirtualNetworkFilterEnabled 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{}
	// Specifies a `virtual_network_rules` resource, used to define which subnets are allowed to access this CosmosDB account.
	VirtualNetworkRules 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 {
	// Capabilities enabled on this Cosmos DB account.
	Capabilities        interface{}
	ConsistencyPolicies interface{}
	// If automatic failover is enabled for this CosmosDB Account.
	EnableAutomaticFailover interface{}
	// If multi-master is enabled for this Cosmos DB account.
	EnableMultipleWriteLocations interface{}
	// The endpoint used to connect to the CosmosDB account.
	Endpoint     interface{}
	GeoLocations interface{}
	// The current IP Filter for this CosmosDB account
	IpRangeFilter interface{}
	// If virtual network filtering is enabled for this Cosmos DB account.
	IsVirtualNetworkFilterEnabled 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{}
	// Subnets that are allowed to access this CosmosDB account.
	VirtualNetworkRules interface{}
	// A list of write endpoints available for this CosmosDB account.
	WriteEndpoints interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id 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 information about an existing CosmosDB (formally DocumentDB) Account.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.