Interface IDatabaseAccountsOperations

Namespace

Microsoft.Azure.Management.CosmosDB.Fluent

Assembly

Microsoft.Azure.Management.CosmosDB.Fluent.dll

DatabaseAccountsOperations operations.

public interface IDatabaseAccountsOperations

Extension Methods

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

DatabaseAccountsOperationsExtensions.BeginDeleteAsync(IDatabaseAccountsOperations, string, string, CancellationToken)

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

DatabaseAccountsOperationsExtensions.BeginOfflineRegionAsync(IDatabaseAccountsOperations, string, string, string, CancellationToken)

DatabaseAccountsOperationsExtensions.BeginOnlineRegionAsync(IDatabaseAccountsOperations, string, string, string, CancellationToken)

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

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

DatabaseAccountsOperationsExtensions.CheckNameExistsAsync(IDatabaseAccountsOperations, string, CancellationToken)

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

DatabaseAccountsOperationsExtensions.DeleteAsync(IDatabaseAccountsOperations, string, string, CancellationToken)

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

DatabaseAccountsOperationsExtensions.GetAsync(IDatabaseAccountsOperations, string, string, CancellationToken)

DatabaseAccountsOperationsExtensions.GetReadOnlyKeysAsync(IDatabaseAccountsOperations, string, string, CancellationToken)

DatabaseAccountsOperationsExtensions.ListAsync(IDatabaseAccountsOperations, CancellationToken)

DatabaseAccountsOperationsExtensions.ListByResourceGroupAsync(IDatabaseAccountsOperations, string, CancellationToken)

DatabaseAccountsOperationsExtensions.ListConnectionStringsAsync(IDatabaseAccountsOperations, string, string, CancellationToken)

DatabaseAccountsOperationsExtensions.ListKeysAsync(IDatabaseAccountsOperations, string, string, CancellationToken)

DatabaseAccountsOperationsExtensions.ListMetricDefinitionsAsync(IDatabaseAccountsOperations, string, string, CancellationToken)

DatabaseAccountsOperationsExtensions.ListMetricsAsync(IDatabaseAccountsOperations, string, string, string, CancellationToken)

DatabaseAccountsOperationsExtensions.ListReadOnlyKeysAsync(IDatabaseAccountsOperations, string, string, CancellationToken)

DatabaseAccountsOperationsExtensions.ListUsagesAsync(IDatabaseAccountsOperations, string, string, string, CancellationToken)

DatabaseAccountsOperationsExtensions.OfflineRegionAsync(IDatabaseAccountsOperations, string, string, string, CancellationToken)

DatabaseAccountsOperationsExtensions.OnlineRegionAsync(IDatabaseAccountsOperations, string, string, string, CancellationToken)

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

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

Methods

BeginCreateOrUpdateWithHttpMessagesAsync(string, string, DatabaseAccountCreateUpdateParameters, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<DatabaseAccountGetResultsInner>> BeginCreateOrUpdateWithHttpMessagesAsync(string resourceGroupName, string accountName, DatabaseAccountCreateUpdateParameters createUpdateParameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<DatabaseAccountGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

BeginDeleteWithHttpMessagesAsync(string, string, Dictionary<string, List<string>>, CancellationToken)

Deletes an existing Azure Cosmos DB database account.

Task<AzureOperationResponse> BeginDeleteWithHttpMessagesAsync(string resourceGroupName, string accountName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

BeginFailoverPriorityChangeWithHttpMessagesAsync(string, string, IList<FailoverPolicy>, Dictionary<string, List<string>>, 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.

Task<AzureOperationResponse> BeginFailoverPriorityChangeWithHttpMessagesAsync(string resourceGroupName, string accountName, IList<FailoverPolicy> failoverPoliciesProperty, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

failoverPoliciesProperty IList<FailoverPolicy>

List of failover policies.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

BeginOfflineRegionWithHttpMessagesAsync(string, string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse> BeginOfflineRegionWithHttpMessagesAsync(string resourceGroupName, string accountName, string region, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

ErrorResponseException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

BeginOnlineRegionWithHttpMessagesAsync(string, string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse> BeginOnlineRegionWithHttpMessagesAsync(string resourceGroupName, string accountName, string region, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

ErrorResponseException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

BeginRegenerateKeyWithHttpMessagesAsync(string, string, KeyKind, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse> BeginRegenerateKeyWithHttpMessagesAsync(string resourceGroupName, string accountName, KeyKind keyKind, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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'

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

BeginUpdateWithHttpMessagesAsync(string, string, DatabaseAccountUpdateParameters, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<DatabaseAccountGetResultsInner>> BeginUpdateWithHttpMessagesAsync(string resourceGroupName, string accountName, DatabaseAccountUpdateParameters updateParameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<DatabaseAccountGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

CheckNameExistsWithHttpMessagesAsync(string, Dictionary<string, List<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.

Task<AzureOperationResponse<bool>> CheckNameExistsWithHttpMessagesAsync(string accountName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

accountName string

Cosmos DB database account name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<bool>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

CreateOrUpdateWithHttpMessagesAsync(string, string, DatabaseAccountCreateUpdateParameters, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<DatabaseAccountGetResultsInner>> CreateOrUpdateWithHttpMessagesAsync(string resourceGroupName, string accountName, DatabaseAccountCreateUpdateParameters createUpdateParameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<DatabaseAccountGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

DeleteWithHttpMessagesAsync(string, string, Dictionary<string, List<string>>, CancellationToken)

Deletes an existing Azure Cosmos DB database account.

Task<AzureOperationResponse> DeleteWithHttpMessagesAsync(string resourceGroupName, string accountName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

FailoverPriorityChangeWithHttpMessagesAsync(string, string, IList<FailoverPolicy>, Dictionary<string, List<string>>, 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.

Task<AzureOperationResponse> FailoverPriorityChangeWithHttpMessagesAsync(string resourceGroupName, string accountName, IList<FailoverPolicy> failoverPoliciesProperty, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

failoverPoliciesProperty IList<FailoverPolicy>

List of failover policies.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

GetReadOnlyKeysWithHttpMessagesAsync(string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<DatabaseAccountListReadOnlyKeysResultInner>> GetReadOnlyKeysWithHttpMessagesAsync(string resourceGroupName, string accountName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<DatabaseAccountListReadOnlyKeysResultInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

GetWithHttpMessagesAsync(string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<DatabaseAccountGetResultsInner>> GetWithHttpMessagesAsync(string resourceGroupName, string accountName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<DatabaseAccountGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

ListByResourceGroupWithHttpMessagesAsync(string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<IEnumerable<DatabaseAccountGetResultsInner>>> ListByResourceGroupWithHttpMessagesAsync(string resourceGroupName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IEnumerable<DatabaseAccountGetResultsInner>>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

ListConnectionStringsWithHttpMessagesAsync(string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<DatabaseAccountListConnectionStringsResultInner>> ListConnectionStringsWithHttpMessagesAsync(string resourceGroupName, string accountName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<DatabaseAccountListConnectionStringsResultInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

ListKeysWithHttpMessagesAsync(string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<DatabaseAccountListKeysResultInner>> ListKeysWithHttpMessagesAsync(string resourceGroupName, string accountName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<DatabaseAccountListKeysResultInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

ListMetricDefinitionsWithHttpMessagesAsync(string, string, Dictionary<string, List<string>>, CancellationToken)

Retrieves metric definitions for the given database account.

Task<AzureOperationResponse<IEnumerable<MetricDefinition>>> ListMetricDefinitionsWithHttpMessagesAsync(string resourceGroupName, string accountName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IEnumerable<MetricDefinition>>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

ListMetricsWithHttpMessagesAsync(string, string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<IEnumerable<Metric>>> ListMetricsWithHttpMessagesAsync(string resourceGroupName, string accountName, string filter, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IEnumerable<Metric>>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

ListReadOnlyKeysWithHttpMessagesAsync(string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<DatabaseAccountListReadOnlyKeysResultInner>> ListReadOnlyKeysWithHttpMessagesAsync(string resourceGroupName, string accountName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<DatabaseAccountListReadOnlyKeysResultInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

ListUsagesWithHttpMessagesAsync(string, string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<IEnumerable<Usage>>> ListUsagesWithHttpMessagesAsync(string resourceGroupName, string accountName, string filter = null, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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).

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IEnumerable<Usage>>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

ListWithHttpMessagesAsync(Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<IEnumerable<DatabaseAccountGetResultsInner>>> ListWithHttpMessagesAsync(Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IEnumerable<DatabaseAccountGetResultsInner>>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

OfflineRegionWithHttpMessagesAsync(string, string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse> OfflineRegionWithHttpMessagesAsync(string resourceGroupName, string accountName, string region, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

ErrorResponseException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

OnlineRegionWithHttpMessagesAsync(string, string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse> OnlineRegionWithHttpMessagesAsync(string resourceGroupName, string accountName, string region, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

ErrorResponseException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

RegenerateKeyWithHttpMessagesAsync(string, string, KeyKind, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse> RegenerateKeyWithHttpMessagesAsync(string resourceGroupName, string accountName, KeyKind keyKind, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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'

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

UpdateWithHttpMessagesAsync(string, string, DatabaseAccountUpdateParameters, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<DatabaseAccountGetResultsInner>> UpdateWithHttpMessagesAsync(string resourceGroupName, string accountName, DatabaseAccountUpdateParameters updateParameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<DatabaseAccountGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null