CosmosDBFirewallRuleCollection.CreateOrUpdateAsync Method

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.4.0-beta.9

Source:

CosmosDBFirewallRuleCollection.cs

Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules/{firewallRuleName}
• Operation Id: MongoClusters_CreateOrUpdateFirewallRule
• Default Api Version: 2024-02-15-preview
• Resource: CosmosDBFirewallRuleResource

public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBFirewallRuleResource>> CreateOrUpdateAsync (Azure.WaitUntil waitUntil, string firewallRuleName, Azure.ResourceManager.CosmosDB.CosmosDBFirewallRuleData data, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.CosmosDB.CosmosDBFirewallRuleData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBFirewallRuleResource>>
override this.CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.CosmosDB.CosmosDBFirewallRuleData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBFirewallRuleResource>>

Public Overridable Function CreateOrUpdateAsync (waitUntil As WaitUntil, firewallRuleName As String, data As CosmosDBFirewallRuleData, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of CosmosDBFirewallRuleResource))

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.

firewallRuleName

String

The name of the mongo cluster firewall rule.

data

CosmosDBFirewallRuleData

The required parameters for creating or updating a firewall rule.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation<CosmosDBFirewallRuleResource>>

Exceptions

ArgumentException

firewallRuleName is an empty string, and was expected to be non-empty.

ArgumentNullException

firewallRuleName or data is null.