Interface ISqlContainer

Namespace

Microsoft.Azure.Management.CosmosDB.Fluent

Assembly

Microsoft.Azure.Management.CosmosDB.Fluent.dll

A SQL container.

public interface ISqlContainer : IBeta, IHasInner<SqlContainerGetResultsInner>, IExternalChildResource<ISqlContainer, ISqlDatabase>, IChildResource<ISqlDatabase>, IHasName, IIndexable, IHasParent<ISqlDatabase>, IRefreshable<ISqlContainer>

Properties

ConflictResolutionPolicy

Gets the conflict resolution policy for the container.

ConflictResolutionPolicy ConflictResolutionPolicy { get; }

Property Value

ConflictResolutionPolicy

DefaultTtl

Gets default time to live.

int? DefaultTtl { get; }

Property Value

int?

IndexingPolicy

Gets the configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container.

IndexingPolicy IndexingPolicy { get; }

Property Value

IndexingPolicy

PartitionKey

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

ContainerPartitionKey PartitionKey { get; }

Property Value

ContainerPartitionKey

SqlContainerId

Gets name of the Cosmos DB SQL container.

string SqlContainerId { get; }

Property Value

string

UniqueKeyPolicy

Gets the unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.

UniqueKeyPolicy UniqueKeyPolicy { get; }

Property Value

UniqueKeyPolicy

_etag

Gets a system generated property representing the resource etag required for optimistic concurrency control.

string _etag { get; }

Property Value

string

_rid

Gets a system generated property. A unique identifier.

string _rid { get; }

Property Value

string

_ts

Gets a system generated property that denotes the last updated timestamp of the resource.

object _ts { get; }

Property Value

object

Methods

GetStoredProcedure(string)

SqlStoredProcedureGetPropertiesResource GetStoredProcedure(string name)

Parameters

name string

The name of the stored procedure.

Returns

SqlStoredProcedureGetPropertiesResource

The specific stored procedure.

GetStoredProcedureAsync(string, CancellationToken)

Task<SqlStoredProcedureGetPropertiesResource> GetStoredProcedureAsync(string name, CancellationToken cancellationToken = default)

Parameters

name string

The name of the stored procedure.

cancellationToken CancellationToken

Returns

Task<SqlStoredProcedureGetPropertiesResource>

The specific stored procedure.

GetThroughputSettings()

ThroughputSettingsGetPropertiesResource GetThroughputSettings()

Returns

ThroughputSettingsGetPropertiesResource

The throughput settings of the SQL container.

GetThroughputSettingsAsync(CancellationToken)

Task<ThroughputSettingsGetPropertiesResource> GetThroughputSettingsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<ThroughputSettingsGetPropertiesResource>

The throughput settings of the SQL container.

GetTrigger(string)

SqlTriggerGetPropertiesResource GetTrigger(string name)

Parameters

name string

The name of the trigger.

Returns

SqlTriggerGetPropertiesResource

The specific trigger.

GetTriggerAsync(string, CancellationToken)

Task<SqlTriggerGetPropertiesResource> GetTriggerAsync(string name, CancellationToken cancellationToken = default)

Parameters

name string

The name of the trigger.

cancellationToken CancellationToken

Returns

Task<SqlTriggerGetPropertiesResource>

The specific trigger.

GetUserDefinedFunction(string)

SqlUserDefinedFunctionGetPropertiesResource GetUserDefinedFunction(string name)

Parameters

name string

The name of the user defined function.

Returns

SqlUserDefinedFunctionGetPropertiesResource

The specific user defined function.

GetUserDefinedFunctionAsync(string, CancellationToken)

Task<SqlUserDefinedFunctionGetPropertiesResource> GetUserDefinedFunctionAsync(string name, CancellationToken cancellationToken = default)

Parameters

name string

The name of the user defined function.

cancellationToken CancellationToken

Returns

Task<SqlUserDefinedFunctionGetPropertiesResource>

The specific user defined function.

ListStoredProcedures()

IEnumerable<SqlStoredProcedureGetPropertiesResource> ListStoredProcedures()

Returns

IEnumerable<SqlStoredProcedureGetPropertiesResource>

All stored procedures in the container.

ListStoredProceduresAsync(CancellationToken)

Task<IEnumerable<SqlStoredProcedureGetPropertiesResource>> ListStoredProceduresAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IEnumerable<SqlStoredProcedureGetPropertiesResource>>

All stored procedures in the container.

ListTriggers()

IEnumerable<SqlTriggerGetPropertiesResource> ListTriggers()

Returns

IEnumerable<SqlTriggerGetPropertiesResource>

All triggers in the container.

ListTriggersAsync(CancellationToken)

Task<IEnumerable<SqlTriggerGetPropertiesResource>> ListTriggersAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IEnumerable<SqlTriggerGetPropertiesResource>>

All triggers in the container.

ListUserDefinedFunctions()

IEnumerable<SqlUserDefinedFunctionGetPropertiesResource> ListUserDefinedFunctions()

Returns

IEnumerable<SqlUserDefinedFunctionGetPropertiesResource>

All user defined functions in the container.

ListUserDefinedFunctionsAsync(CancellationToken)

Task<IEnumerable<SqlUserDefinedFunctionGetPropertiesResource>> ListUserDefinedFunctionsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IEnumerable<SqlUserDefinedFunctionGetPropertiesResource>>

All user defined functions in the container.