CosmosDBContainerPartitionKey Class

Reference

Definition

Namespace:: Azure.Provisioning.CosmosDB

Assembly:: Azure.Provisioning.CosmosDB.dll

Package:: Azure.Provisioning.CosmosDB v1.0.0

Package:: Azure.Provisioning.CosmosDB v1.0.0-beta.1

Source:: CosmosDBContainerPartitionKey.cs

Source:: CosmosDBContainerPartitionKey.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The configuration of the partition key to be used for partitioning data into multiple partitions.

public class CosmosDBContainerPartitionKey : Azure.Provisioning.Primitives.ProvisionableConstruct

public class CosmosDBContainerPartitionKey : Azure.Provisioning.Primitives.ProvisioningConstruct

type CosmosDBContainerPartitionKey = class
    inherit ProvisionableConstruct

type CosmosDBContainerPartitionKey = class
    inherit ProvisioningConstruct

Public Class CosmosDBContainerPartitionKey
Inherits ProvisionableConstruct

Public Class CosmosDBContainerPartitionKey
Inherits ProvisioningConstruct

Inheritance: Object

Provisionable

ProvisionableConstruct
CosmosDBContainerPartitionKey

Inheritance: Object

Provisionable

ProvisioningConstruct
CosmosDBContainerPartitionKey

Constructors

CosmosDBContainerPartitionKey()

Creates a new CosmosDBContainerPartitionKey.

Properties

IsSystemKey	Indicates if the container is using a system generated partition key.
Kind	Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create.
Paths	List of paths using which data within the container can be partitioned.
Version	Indicates the version of the partition key definition.

Methods

AssignOrReplace<T>(T, T)	(Inherited from ProvisionableConstruct)
Compile()	Compile the resource into a set of Bicep statements. (Inherited from ProvisionableConstruct)
Compile()	Compile the resource into a set of Bicep statements. (Inherited from ProvisioningConstruct)
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean)	(Inherited from ProvisionableConstruct)
DefineListProperty<T>(String, String[], Boolean, Boolean)	(Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String)	(Inherited from ProvisionableConstruct)
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String)	(Inherited from ProvisionableConstruct)
DefineProvisionableProperties()	Define all the provisionable properties of CosmosDBContainerPartitionKey.
GetProvisionableResources()	Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable)
GetResources()	Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable)
Initialize()	Initialize this construct. (Inherited from ProvisionableConstruct)
OverrideWithExpression(BicepExpression)	(Inherited from ProvisionableConstruct)
OverrideWithExpression(Expression)	Set this construct to represent the result of an expression. This is primarily meant to be called via `FromExpression` static methods on specific resources or constructs. (Inherited from ProvisioningConstruct)
Resolve(ProvisioningBuildOptions)	Resolve any resources or properties that were not explicitly specified. (Inherited from ProvisionableConstruct)
Resolve(ProvisioningBuildOptions)	Resolve any resources or properties that were not explicitly specified. (Inherited from Provisionable)
Resolve(ProvisioningContext)	Resolve any resources or properties that were not explicitly specified. (Inherited from Provisionable)
Resolve(ProvisioningContext)	Resolve any resources or properties that were not explicitly specified. (Inherited from ProvisioningConstruct)
Validate(ProvisioningBuildOptions)	Validate the presence of any required members. (Inherited from ProvisionableConstruct)
Validate(ProvisioningBuildOptions)	Validate the presence of any required members. (Inherited from Provisionable)
Validate(ProvisioningContext)	Validate the presence of any required members. (Inherited from Provisionable)
Validate(ProvisioningContext)	Validate the presence of any required members. (Inherited from ProvisioningConstruct)

Explicit Interface Implementations

IBicepValue.Assign(IBicepValue)	Assign a value to this property. (Inherited from ProvisionableConstruct)
IBicepValue.Compile()	Compile this value to a Bicep expression. (Inherited from ProvisionableConstruct)
IBicepValue.Expression	Gets the expression for this value if it's not a literal. (Inherited from ProvisionableConstruct)
IBicepValue.IsEmpty	Gets whether this value is unset or empty. (Inherited from ProvisionableConstruct)
IBicepValue.IsOutput	Tracks whether this is an output only property. (Inherited from ProvisionableConstruct)
IBicepValue.IsRequired	Tracks whether this property is required. (Inherited from ProvisionableConstruct)
IBicepValue.IsSecure	Tracks whether this contains a secure value. (Inherited from ProvisionableConstruct)
IBicepValue.Kind	Gets the kind of this value (a literal value, an expression, or it's unset). (Inherited from ProvisionableConstruct)
IBicepValue.LiteralValue	Get the value of this expression, if it's literal. (Inherited from ProvisionableConstruct)
IBicepValue.Self	Gets information about where this value was defined. (Inherited from ProvisionableConstruct)
IBicepValue.SetReadOnly()	Make this value readonly. (Inherited from ProvisionableConstruct)
IBicepValue.Source	Gets information about where this value was assigned from. (Inherited from ProvisionableConstruct)

Applies to

Dela via