IDatabaseAccountsOperations.BeginOfflineRegionWithHttpMessagesAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Management.CosmosDB

Assembly:: Microsoft.Azure.Management.CosmosDB.dll

Package:: Microsoft.Azure.Management.CosmosDB v3.3.0

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.

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

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> BeginOfflineRegionWithHttpMessagesAsync (string resourceGroupName, string accountName, Microsoft.Azure.Management.CosmosDB.Models.RegionForOnlineOffline regionParameterForOffline, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member BeginOfflineRegionWithHttpMessagesAsync : string * string * Microsoft.Azure.Management.CosmosDB.Models.RegionForOnlineOffline * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>

Public Function BeginOfflineRegionWithHttpMessagesAsync (resourceGroupName As String, accountName As String, regionParameterForOffline As RegionForOnlineOffline, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parameters

resourceGroupName: String

The name of the resource group. The name is case insensitive.

accountName: String

Cosmos DB database account name.

regionParameterForOffline: RegionForOnlineOffline

Cosmos DB region to offline for the database account.

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

ValidationException

Thrown when a required parameter is null

Applies to

Share via