cosmosdb

package
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Sep 4, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

nolint: lll Package cosmosdb exports types, functions, subpackages for provisioning cosmosdb resources.

> This provider is a derived work of the [Terraform Provider](https://github.com/terraform-providers/terraform-provider-azurerm) > distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature, > first check the [`pulumi/pulumi-azure` repo](https://github.com/pulumi/pulumi-azure/issues); however, if that doesn't turn up anything, > please consult the source [`terraform-providers/terraform-provider-azurerm` repo](https://github.com/terraform-providers/terraform-provider-azurerm/issues).

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.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/cosmosdb_account.html.markdown.

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

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

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 `consistencyPolicy` 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 `geoLocation` resource, used to define where data should be replicated with the `failoverPriority` 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

The capability to enable - Possible values are `EnableTable`, `EnableCassandra`, and `EnableGremlin`.

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 `virtualNetworkRules` 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 {
	// The capabilities which should be enabled for this Cosmos DB account. Possible values are `EnableAggregationPipeline`, `EnableCassandra`, `EnableGremlin`, `EnableTable`, `MongoDBv3.4`, and `mongoEnableDocLevelTTL`.
	Capabilities interface{}
	// Specifies a `consistencyPolicy` 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 `geoLocation` resource, used to define where data should be replicated with the `failoverPriority` 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{}
	// The capability to enable - Possible values are `EnableTable`, `EnableCassandra`, and `EnableGremlin`.
	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 `virtualNetworkRules` 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 {
	// The capabilities which should be enabled for this Cosmos DB account. Possible values are `EnableAggregationPipeline`, `EnableCassandra`, `EnableGremlin`, `EnableTable`, `MongoDBv3.4`, and `mongoEnableDocLevelTTL`.
	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 `consistencyPolicy` 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 `geoLocation` resource, used to define where data should be replicated with the `failoverPriority` 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{}
	// The capability to enable - Possible values are `EnableTable`, `EnableCassandra`, and `EnableGremlin`.
	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 `virtualNetworkRules` 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 CassandraKeyspace added in v0.18.3 

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

Manages a Cassandra KeySpace within a Cosmos DB Account.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/cosmosdb_cassandra_keyspace.html.markdown.

func GetCassandraKeyspace added in v0.18.3 

func GetCassandraKeyspace(ctx *pulumi.Context,
	name string, id pulumi.ID, state *CassandraKeyspaceState, opts ...pulumi.ResourceOpt) (*CassandraKeyspace, error)

GetCassandraKeyspace gets an existing CassandraKeyspace 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 NewCassandraKeyspace added in v0.18.3 

func NewCassandraKeyspace(ctx *pulumi.Context,
	name string, args *CassandraKeyspaceArgs, opts ...pulumi.ResourceOpt) (*CassandraKeyspace, error)

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

func (*CassandraKeyspace) AccountName added in v0.18.3 

func (r *CassandraKeyspace) AccountName() *pulumi.StringOutput

The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.

func (*CassandraKeyspace) ID added in v0.18.3 

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

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

func (*CassandraKeyspace) Name added in v0.18.3 

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

Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.

func (*CassandraKeyspace) ResourceGroupName added in v0.18.3 

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

The name of the resource group in which the Cosmos DB Cassandra KeySpace is created. Changing this forces a new resource to be created.

func (*CassandraKeyspace) URN added in v0.18.3 

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

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

type CassandraKeyspaceArgs added in v0.18.3 

type CassandraKeyspaceArgs struct {
	// The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
	AccountName interface{}
	// Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the resource group in which the Cosmos DB Cassandra KeySpace is created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
}

The set of arguments for constructing a CassandraKeyspace resource.

type CassandraKeyspaceState added in v0.18.3 

type CassandraKeyspaceState struct {
	// The name of the Cosmos DB Cassandra KeySpace to create the table within. Changing this forces a new resource to be created.
	AccountName interface{}
	// Specifies the name of the Cosmos DB Cassandra KeySpace. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the resource group in which the Cosmos DB Cassandra KeySpace is created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
}

Input properties used for looking up and filtering CassandraKeyspace 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{}
	Name     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{}
	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 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.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/cosmosdb_account.html.markdown.

type MongoCollection added in v0.18.3 

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

Manages a Mongo Collection within a Cosmos DB Account.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/cosmosdb_mongo_collection.html.markdown.

func GetMongoCollection added in v0.18.3 

func GetMongoCollection(ctx *pulumi.Context,
	name string, id pulumi.ID, state *MongoCollectionState, opts ...pulumi.ResourceOpt) (*MongoCollection, error)

GetMongoCollection gets an existing MongoCollection 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 NewMongoCollection added in v0.18.3 

func NewMongoCollection(ctx *pulumi.Context,
	name string, args *MongoCollectionArgs, opts ...pulumi.ResourceOpt) (*MongoCollection, error)

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

func (*MongoCollection) AccountName added in v0.18.3 

func (r *MongoCollection) AccountName() *pulumi.StringOutput

func (*MongoCollection) DatabaseName added in v0.18.3 

func (r *MongoCollection) DatabaseName() *pulumi.StringOutput

The name of the Cosmos DB Mongo Database in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

func (*MongoCollection) DefaultTtlSeconds added in v0.18.3 

func (r *MongoCollection) DefaultTtlSeconds() *pulumi.IntOutput

The default Time To Live in seconds. If the value is `-1` items are not automatically expired.

func (*MongoCollection) ID added in v0.18.3 

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

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

func (*MongoCollection) Indexes added in v0.18.3 

func (r *MongoCollection) Indexes() *pulumi.ArrayOutput

One or more `indexes` blocks as defined below.

func (*MongoCollection) Name added in v0.18.3 

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

Specifies the name of the Cosmos DB Mongo Collection. Changing this forces a new resource to be created.

func (*MongoCollection) ResourceGroupName added in v0.18.3 

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

The name of the resource group in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.

func (*MongoCollection) ShardKey added in v0.18.3 

func (r *MongoCollection) ShardKey() *pulumi.StringOutput

The name of the key to partition on for sharding. There must not be any other unique index keys.

func (*MongoCollection) URN added in v0.18.3 

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

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

type MongoCollectionArgs added in v0.18.3 

type MongoCollectionArgs struct {
	AccountName interface{}
	// The name of the Cosmos DB Mongo Database in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.
	DatabaseName interface{}
	// The default Time To Live in seconds. If the value is `-1` items are not automatically expired.
	DefaultTtlSeconds interface{}
	// One or more `indexes` blocks as defined below.
	Indexes interface{}
	// Specifies the name of the Cosmos DB Mongo Collection. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the resource group in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// The name of the key to partition on for sharding. There must not be any other unique index keys.
	ShardKey interface{}
}

The set of arguments for constructing a MongoCollection resource.

type MongoCollectionState added in v0.18.3 

type MongoCollectionState struct {
	AccountName interface{}
	// The name of the Cosmos DB Mongo Database in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.
	DatabaseName interface{}
	// The default Time To Live in seconds. If the value is `-1` items are not automatically expired.
	DefaultTtlSeconds interface{}
	// One or more `indexes` blocks as defined below.
	Indexes interface{}
	// Specifies the name of the Cosmos DB Mongo Collection. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the resource group in which the Cosmos DB Mongo Collection is created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// The name of the key to partition on for sharding. There must not be any other unique index keys.
	ShardKey interface{}
}

Input properties used for looking up and filtering MongoCollection resources.

type MongoDatabase added in v0.18.3 

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

Manages a Mongo Database within a Cosmos DB Account.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/cosmosdb_mongo_database.html.markdown.

func GetMongoDatabase added in v0.18.3 

func GetMongoDatabase(ctx *pulumi.Context,
	name string, id pulumi.ID, state *MongoDatabaseState, opts ...pulumi.ResourceOpt) (*MongoDatabase, error)

GetMongoDatabase gets an existing MongoDatabase 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 NewMongoDatabase added in v0.18.3 

func NewMongoDatabase(ctx *pulumi.Context,
	name string, args *MongoDatabaseArgs, opts ...pulumi.ResourceOpt) (*MongoDatabase, error)

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

func (*MongoDatabase) AccountName added in v0.18.3 

func (r *MongoDatabase) AccountName() *pulumi.StringOutput

The name of the Cosmos DB Mongo Database to create the table within. Changing this forces a new resource to be created.

func (*MongoDatabase) ID added in v0.18.3 

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

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

func (*MongoDatabase) Name added in v0.18.3 

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

Specifies the name of the Cosmos DB Mongo Database. Changing this forces a new resource to be created.

func (*MongoDatabase) ResourceGroupName added in v0.18.3 

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

The name of the resource group in which the Cosmos DB Mongo Database is created. Changing this forces a new resource to be created.

func (*MongoDatabase) URN added in v0.18.3 

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

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

type MongoDatabaseArgs added in v0.18.3 

type MongoDatabaseArgs struct {
	// The name of the Cosmos DB Mongo Database to create the table within. Changing this forces a new resource to be created.
	AccountName interface{}
	// Specifies the name of the Cosmos DB Mongo Database. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the resource group in which the Cosmos DB Mongo Database is created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
}

The set of arguments for constructing a MongoDatabase resource.

type MongoDatabaseState added in v0.18.3 

type MongoDatabaseState struct {
	// The name of the Cosmos DB Mongo Database to create the table within. Changing this forces a new resource to be created.
	AccountName interface{}
	// Specifies the name of the Cosmos DB Mongo Database. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the resource group in which the Cosmos DB Mongo Database is created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
}

Input properties used for looking up and filtering MongoDatabase resources.

type SqlContainer added in v1.0.0 

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

Manages a SQL Container within a Cosmos DB Account.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/cosmosdb_sql_container.html.markdown.

func GetSqlContainer added in v1.0.0 

func GetSqlContainer(ctx *pulumi.Context,
	name string, id pulumi.ID, state *SqlContainerState, opts ...pulumi.ResourceOpt) (*SqlContainer, error)

GetSqlContainer gets an existing SqlContainer 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 NewSqlContainer added in v1.0.0 

func NewSqlContainer(ctx *pulumi.Context,
	name string, args *SqlContainerArgs, opts ...pulumi.ResourceOpt) (*SqlContainer, error)

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

func (*SqlContainer) AccountName added in v1.0.0 

func (r *SqlContainer) AccountName() *pulumi.StringOutput

The name of the Cosmos DB Account to create the container within. Changing this forces a new resource to be created.

func (*SqlContainer) DatabaseName added in v1.0.0 

func (r *SqlContainer) DatabaseName() *pulumi.StringOutput

The name of the Cosmos DB SQL Database to create the container within. Changing this forces a new resource to be created.

func (*SqlContainer) ID added in v1.0.0 

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

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

func (*SqlContainer) Name added in v1.0.0 

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

Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.

func (*SqlContainer) PartitionKeyPath added in v1.0.0 

func (r *SqlContainer) PartitionKeyPath() *pulumi.StringOutput

Define a partition key. Changing this forces a new resource to be created.

func (*SqlContainer) ResourceGroupName added in v1.0.0 

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

The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.

func (*SqlContainer) URN added in v1.0.0 

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

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

func (*SqlContainer) UniqueKeys added in v1.0.0 

func (r *SqlContainer) UniqueKeys() *pulumi.ArrayOutput

One or more `uniqueKey` blocks as defined below. Changing this forces a new resource to be created.

type SqlContainerArgs added in v1.0.0 

type SqlContainerArgs struct {
	// The name of the Cosmos DB Account to create the container within. Changing this forces a new resource to be created.
	AccountName interface{}
	// The name of the Cosmos DB SQL Database to create the container within. Changing this forces a new resource to be created.
	DatabaseName interface{}
	// Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
	Name interface{}
	// Define a partition key. Changing this forces a new resource to be created.
	PartitionKeyPath interface{}
	// The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// One or more `uniqueKey` blocks as defined below. Changing this forces a new resource to be created.
	UniqueKeys interface{}
}

The set of arguments for constructing a SqlContainer resource.

type SqlContainerState added in v1.0.0 

type SqlContainerState struct {
	// The name of the Cosmos DB Account to create the container within. Changing this forces a new resource to be created.
	AccountName interface{}
	// The name of the Cosmos DB SQL Database to create the container within. Changing this forces a new resource to be created.
	DatabaseName interface{}
	// Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
	Name interface{}
	// Define a partition key. Changing this forces a new resource to be created.
	PartitionKeyPath interface{}
	// The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// One or more `uniqueKey` blocks as defined below. Changing this forces a new resource to be created.
	UniqueKeys interface{}
}

Input properties used for looking up and filtering SqlContainer resources.

type SqlDatabase added in v0.18.3 

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

Manages a SQL Database within a Cosmos DB Account.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/cosmosdb_sql_database.html.markdown.

func GetSqlDatabase added in v0.18.3 

func GetSqlDatabase(ctx *pulumi.Context,
	name string, id pulumi.ID, state *SqlDatabaseState, opts ...pulumi.ResourceOpt) (*SqlDatabase, error)

GetSqlDatabase gets an existing SqlDatabase 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 NewSqlDatabase added in v0.18.3 

func NewSqlDatabase(ctx *pulumi.Context,
	name string, args *SqlDatabaseArgs, opts ...pulumi.ResourceOpt) (*SqlDatabase, error)

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

func (*SqlDatabase) AccountName added in v0.18.3 

func (r *SqlDatabase) AccountName() *pulumi.StringOutput

The name of the Cosmos DB SQL Database to create the table within. Changing this forces a new resource to be created.

func (*SqlDatabase) ID added in v0.18.3 

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

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

func (*SqlDatabase) Name added in v0.18.3 

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

Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.

func (*SqlDatabase) ResourceGroupName added in v0.18.3 

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

The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.

func (*SqlDatabase) URN added in v0.18.3 

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

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

type SqlDatabaseArgs added in v0.18.3 

type SqlDatabaseArgs struct {
	// The name of the Cosmos DB SQL Database to create the table within. Changing this forces a new resource to be created.
	AccountName interface{}
	// Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
}

The set of arguments for constructing a SqlDatabase resource.

type SqlDatabaseState added in v0.18.3 

type SqlDatabaseState struct {
	// The name of the Cosmos DB SQL Database to create the table within. Changing this forces a new resource to be created.
	AccountName interface{}
	// Specifies the name of the Cosmos DB SQL Database. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the resource group in which the Cosmos DB SQL Database is created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
}

Input properties used for looking up and filtering SqlDatabase resources.

type Table added in v0.18.3 

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

Manages a Table within a Cosmos DB Account.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/cosmosdb_table.html.markdown.

func GetTable added in v0.18.3 

func GetTable(ctx *pulumi.Context,
	name string, id pulumi.ID, state *TableState, opts ...pulumi.ResourceOpt) (*Table, error)

GetTable gets an existing Table 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 NewTable added in v0.18.3 

func NewTable(ctx *pulumi.Context,
	name string, args *TableArgs, opts ...pulumi.ResourceOpt) (*Table, error)

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

func (*Table) AccountName added in v0.18.3 

func (r *Table) AccountName() *pulumi.StringOutput

The name of the Cosmos DB Table to create the table within. Changing this forces a new resource to be created.

func (*Table) ID added in v0.18.3 

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

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

func (*Table) Name added in v0.18.3 

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

Specifies the name of the Cosmos DB Table. Changing this forces a new resource to be created.

func (*Table) ResourceGroupName added in v0.18.3 

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

The name of the resource group in which the Cosmos DB Table is created. Changing this forces a new resource to be created.

func (*Table) URN added in v0.18.3 

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

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

type TableArgs added in v0.18.3 

type TableArgs struct {
	// The name of the Cosmos DB Table to create the table within. Changing this forces a new resource to be created.
	AccountName interface{}
	// Specifies the name of the Cosmos DB Table. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the resource group in which the Cosmos DB Table is created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
}

The set of arguments for constructing a Table resource.

type TableState added in v0.18.3 

type TableState struct {
	// The name of the Cosmos DB Table to create the table within. Changing this forces a new resource to be created.
	AccountName interface{}
	// Specifies the name of the Cosmos DB Table. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the resource group in which the Cosmos DB Table is created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
}

Input properties used for looking up and filtering Table resources.

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.