CosmosDBFirewallRuleCollection.CreateOrUpdate 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: MongoClusters_CreateOrUpdateFirewallRule
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBFirewallRuleResource
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBFirewallRuleResource> CreateOrUpdate (Azure.WaitUntil waitUntil, string firewallRuleName, Azure.ResourceManager.CosmosDB.CosmosDBFirewallRuleData data, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.CosmosDB.CosmosDBFirewallRuleData * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBFirewallRuleResource>
override this.CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.CosmosDB.CosmosDBFirewallRuleData * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBFirewallRuleResource>
Public Overridable Function CreateOrUpdate (waitUntil As WaitUntil, firewallRuleName As String, data As CosmosDBFirewallRuleData, Optional cancellationToken As CancellationToken = Nothing) As 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

Exceptions

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

firewallRuleName or data is null.

Applies to