Interface ISqlDatabase

Namespace

Microsoft.Azure.Management.CosmosDB.Fluent

Assembly

Microsoft.Azure.Management.CosmosDB.Fluent.dll

A SQL database.

public interface ISqlDatabase : IBeta, IHasInner<SqlDatabaseGetResultsInner>, IExternalChildResource<ISqlDatabase, ICosmosDBAccount>, IChildResource<ICosmosDBAccount>, IHasName, IIndexable, IHasParent<ICosmosDBAccount>, IRefreshable<ISqlDatabase>

Properties

SqlDatabaseId

Gets name of the Cosmos DB SQL database.

string SqlDatabaseId { get; }

Property Value

string

_colls

Gets a system generated property that specified the addressable path of the collections resource.

string _colls { get; }

Property Value

string

_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

_users

Gets a system generated property that specifies the addressable path of the users resource.

string _users { get; }

Property Value

string

Methods

GetSqlContainer(string)

ISqlContainer GetSqlContainer(string name)

Parameters

name string

The name of the SQL container.

Returns

ISqlContainer

The specific SQL container.

GetSqlContainerAsync(string, CancellationToken)

Task<ISqlContainer> GetSqlContainerAsync(string name, CancellationToken cancellationToken = default)

Parameters

name string

The name of the SQL container.

cancellationToken CancellationToken

Returns

Task<ISqlContainer>

The specific SQL container.

GetThroughputSettings()

ThroughputSettingsGetPropertiesResource GetThroughputSettings()

Returns

ThroughputSettingsGetPropertiesResource

The throughput settings of the SQL database.

GetThroughputSettingsAsync(CancellationToken)

Task<ThroughputSettingsGetPropertiesResource> GetThroughputSettingsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<ThroughputSettingsGetPropertiesResource>

The throughput settings of the SQL database.

ListSqlContainers()

IEnumerable<ISqlContainer> ListSqlContainers()

Returns

IEnumerable<ISqlContainer>

All SQL containers in the DB.

ListSqlContainersAsync(CancellationToken)

Task<IEnumerable<ISqlContainer>> ListSqlContainersAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IEnumerable<ISqlContainer>>

All SQL containers in the DB.