Class DatabaseAccountsOperationsExtensions

Namespace

Microsoft.Azure.Management.CosmosDB.Fluent

Assembly

Microsoft.Azure.Management.CosmosDB.Fluent.dll

Extension methods for DatabaseAccountsOperations.

public static class DatabaseAccountsOperationsExtensions

Inheritance

object

DatabaseAccountsOperationsExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

BeginCreateOrUpdateAsync(IDatabaseAccountsOperations, string, string, DatabaseAccountCreateUpdateParameters, CancellationToken)

Creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account.

public static Task<DatabaseAccountGetResultsInner> BeginCreateOrUpdateAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, DatabaseAccountCreateUpdateParameters createUpdateParameters, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

createUpdateParameters DatabaseAccountCreateUpdateParameters

The parameters to provide for the current database account.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<DatabaseAccountGetResultsInner>

BeginDeleteAsync(IDatabaseAccountsOperations, string, string, CancellationToken)

Deletes an existing Azure Cosmos DB database account.

public static Task BeginDeleteAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

BeginFailoverPriorityChangeAsync(IDatabaseAccountsOperations, string, string, IList<FailoverPolicy>, CancellationToken)

Changes the failover priority for the Azure Cosmos DB database account. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.

public static Task BeginFailoverPriorityChangeAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, IList<FailoverPolicy> failoverPoliciesProperty, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

failoverPoliciesProperty IList<FailoverPolicy>

List of failover policies.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

BeginOfflineRegionAsync(IDatabaseAccountsOperations, string, string, string, CancellationToken)

Offline the specified region for the specified Azure Cosmos DB database account.

public static Task BeginOfflineRegionAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, string region, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

region string

Cosmos DB region, with spaces between words and each word capitalized.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

BeginOnlineRegionAsync(IDatabaseAccountsOperations, string, string, string, CancellationToken)

Online the specified region for the specified Azure Cosmos DB database account.

public static Task BeginOnlineRegionAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, string region, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

region string

Cosmos DB region, with spaces between words and each word capitalized.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

BeginRegenerateKeyAsync(IDatabaseAccountsOperations, string, string, KeyKind, CancellationToken)

Regenerates an access key for the specified Azure Cosmos DB database account.

public static Task BeginRegenerateKeyAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, KeyKind keyKind, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

keyKind KeyKind

The access key to regenerate. Possible values include: 'primary', 'secondary', 'primaryReadonly', 'secondaryReadonly'

cancellationToken CancellationToken

The cancellation token.

Returns

Task

BeginUpdateAsync(IDatabaseAccountsOperations, string, string, DatabaseAccountUpdateParameters, CancellationToken)

Updates the properties of an existing Azure Cosmos DB database account.

public static Task<DatabaseAccountGetResultsInner> BeginUpdateAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, DatabaseAccountUpdateParameters updateParameters, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

updateParameters DatabaseAccountUpdateParameters

The parameters to provide for the current database account.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<DatabaseAccountGetResultsInner>

CheckNameExistsAsync(IDatabaseAccountsOperations, string, CancellationToken)

Checks that the Azure Cosmos DB account name already exists. A valid account name may contain only lowercase letters, numbers, and the '-' character, and must be between 3 and 50 characters.

public static Task<bool> CheckNameExistsAsync(this IDatabaseAccountsOperations operations, string accountName, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

accountName string

Cosmos DB database account name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<bool>

CreateOrUpdateAsync(IDatabaseAccountsOperations, string, string, DatabaseAccountCreateUpdateParameters, CancellationToken)

Creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account.

public static Task<DatabaseAccountGetResultsInner> CreateOrUpdateAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, DatabaseAccountCreateUpdateParameters createUpdateParameters, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

createUpdateParameters DatabaseAccountCreateUpdateParameters

The parameters to provide for the current database account.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<DatabaseAccountGetResultsInner>

DeleteAsync(IDatabaseAccountsOperations, string, string, CancellationToken)

Deletes an existing Azure Cosmos DB database account.

public static Task DeleteAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

FailoverPriorityChangeAsync(IDatabaseAccountsOperations, string, string, IList<FailoverPolicy>, CancellationToken)

Changes the failover priority for the Azure Cosmos DB database account. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.

public static Task FailoverPriorityChangeAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, IList<FailoverPolicy> failoverPoliciesProperty, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

failoverPoliciesProperty IList<FailoverPolicy>

List of failover policies.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

GetAsync(IDatabaseAccountsOperations, string, string, CancellationToken)

Retrieves the properties of an existing Azure Cosmos DB database account.

public static Task<DatabaseAccountGetResultsInner> GetAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<DatabaseAccountGetResultsInner>

GetReadOnlyKeysAsync(IDatabaseAccountsOperations, string, string, CancellationToken)

Lists the read-only access keys for the specified Azure Cosmos DB database account.

public static Task<DatabaseAccountListReadOnlyKeysResultInner> GetReadOnlyKeysAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<DatabaseAccountListReadOnlyKeysResultInner>

ListAsync(IDatabaseAccountsOperations, CancellationToken)

Lists all the Azure Cosmos DB database accounts available under the subscription.

public static Task<IEnumerable<DatabaseAccountGetResultsInner>> ListAsync(this IDatabaseAccountsOperations operations, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IEnumerable<DatabaseAccountGetResultsInner>>

ListByResourceGroupAsync(IDatabaseAccountsOperations, string, CancellationToken)

Lists all the Azure Cosmos DB database accounts available under the given resource group.

public static Task<IEnumerable<DatabaseAccountGetResultsInner>> ListByResourceGroupAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IEnumerable<DatabaseAccountGetResultsInner>>

ListConnectionStringsAsync(IDatabaseAccountsOperations, string, string, CancellationToken)

Lists the connection strings for the specified Azure Cosmos DB database account.

public static Task<DatabaseAccountListConnectionStringsResultInner> ListConnectionStringsAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<DatabaseAccountListConnectionStringsResultInner>

ListKeysAsync(IDatabaseAccountsOperations, string, string, CancellationToken)

Lists the access keys for the specified Azure Cosmos DB database account.

public static Task<DatabaseAccountListKeysResultInner> ListKeysAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<DatabaseAccountListKeysResultInner>

ListMetricDefinitionsAsync(IDatabaseAccountsOperations, string, string, CancellationToken)

Retrieves metric definitions for the given database account.

public static Task<IEnumerable<MetricDefinition>> ListMetricDefinitionsAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IEnumerable<MetricDefinition>>

ListMetricsAsync(IDatabaseAccountsOperations, string, string, string, CancellationToken)

Retrieves the metrics determined by the given filter for the given database account.

public static Task<IEnumerable<Metric>> ListMetricsAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, string filter, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

filter string

An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IEnumerable<Metric>>

ListReadOnlyKeysAsync(IDatabaseAccountsOperations, string, string, CancellationToken)

Lists the read-only access keys for the specified Azure Cosmos DB database account.

public static Task<DatabaseAccountListReadOnlyKeysResultInner> ListReadOnlyKeysAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<DatabaseAccountListReadOnlyKeysResultInner>

ListUsagesAsync(IDatabaseAccountsOperations, string, string, string, CancellationToken)

Retrieves the usages (most recent data) for the given database account.

public static Task<IEnumerable<Usage>> ListUsagesAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, string filter = null, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

filter string

An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IEnumerable<Usage>>

OfflineRegionAsync(IDatabaseAccountsOperations, string, string, string, CancellationToken)

Offline the specified region for the specified Azure Cosmos DB database account.

public static Task OfflineRegionAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, string region, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

region string

Cosmos DB region, with spaces between words and each word capitalized.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

OnlineRegionAsync(IDatabaseAccountsOperations, string, string, string, CancellationToken)

Online the specified region for the specified Azure Cosmos DB database account.

public static Task OnlineRegionAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, string region, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

region string

Cosmos DB region, with spaces between words and each word capitalized.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

RegenerateKeyAsync(IDatabaseAccountsOperations, string, string, KeyKind, CancellationToken)

Regenerates an access key for the specified Azure Cosmos DB database account.

public static Task RegenerateKeyAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, KeyKind keyKind, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

keyKind KeyKind

The access key to regenerate. Possible values include: 'primary', 'secondary', 'primaryReadonly', 'secondaryReadonly'

cancellationToken CancellationToken

The cancellation token.

Returns

Task

UpdateAsync(IDatabaseAccountsOperations, string, string, DatabaseAccountUpdateParameters, CancellationToken)

Updates the properties of an existing Azure Cosmos DB database account.

public static Task<DatabaseAccountGetResultsInner> UpdateAsync(this IDatabaseAccountsOperations operations, string resourceGroupName, string accountName, DatabaseAccountUpdateParameters updateParameters, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseAccountsOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

updateParameters DatabaseAccountUpdateParameters

The parameters to provide for the current database account.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<DatabaseAccountGetResultsInner>