CosmosDBAccountResource.OnlineRegion Method

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDB

Assembly:: Azure.ResourceManager.CosmosDB.dll

Package:: Azure.ResourceManager.CosmosDB v1.3.2

Package:: Azure.ResourceManager.CosmosDB v1.4.0-beta.11

Source:: CosmosDBAccountResource.cs

Source:: CosmosDBAccountResource.cs

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.

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

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

public virtual Azure.ResourceManager.ArmOperation OnlineRegion (Azure.WaitUntil waitUntil, Azure.ResourceManager.CosmosDB.Models.RegionForOnlineOffline regionParameterForOnline, System.Threading.CancellationToken cancellationToken = default);

abstract member OnlineRegion : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.RegionForOnlineOffline * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation
override this.OnlineRegion : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.RegionForOnlineOffline * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation

Public Overridable Function OnlineRegion (waitUntil As WaitUntil, regionParameterForOnline As RegionForOnlineOffline, Optional cancellationToken As CancellationToken = Nothing) As 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.

regionParameterForOnline: RegionForOnlineOffline

Cosmos DB region to online for the database account.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

ArmOperation

Exceptions

ArgumentNullException

regionParameterForOnline is null.

Applies to

Share via