MongoClusterFirewallRuleCollection.CreateOrUpdateAsync Method

Definition

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. : FirewallRules_CreateOrUpdate.
  • Default Api Version. : 2026-02-01-preview.
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.MongoCluster.MongoClusterFirewallRuleResource>> CreateOrUpdateAsync(Azure.WaitUntil waitUntil, string firewallRuleName, Azure.ResourceManager.MongoCluster.MongoClusterFirewallRuleData data, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.MongoCluster.MongoClusterFirewallRuleData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.MongoCluster.MongoClusterFirewallRuleResource>>
override this.CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.MongoCluster.MongoClusterFirewallRuleData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.MongoCluster.MongoClusterFirewallRuleResource>>
Public Overridable Function CreateOrUpdateAsync (waitUntil As WaitUntil, firewallRuleName As String, data As MongoClusterFirewallRuleData, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of MongoClusterFirewallRuleResource))

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
MongoClusterFirewallRuleData

Resource create parameters.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

firewallRuleName or data is null.

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

Applies to