CosmosDBAccountResource.OfflineRegionAsync Method

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.3.2

Source:

CosmosDBAccountResource.cs

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

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/offlineRegion
• Operation Id: DatabaseAccounts_OfflineRegion
• Default Api Version: 2024-09-01-preview
• Resource: CosmosDBAccountResource

public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> OfflineRegionAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.CosmosDB.Models.RegionForOnlineOffline regionParameterForOffline, System.Threading.CancellationToken cancellationToken = default);

abstract member OfflineRegionAsync : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.RegionForOnlineOffline * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
override this.OfflineRegionAsync : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.RegionForOnlineOffline * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>

Public Overridable Function OfflineRegionAsync (waitUntil As WaitUntil, regionParameterForOffline As RegionForOnlineOffline, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation)

Parameters

waitUntil

WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

regionParameterForOffline

RegionForOnlineOffline

Cosmos DB region to offline for the database account.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation>

Exceptions

ArgumentNullException

regionParameterForOffline is null.