CosmosDBFirewallRuleResource.UpdateAsync 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 System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBFirewallRuleResource>> UpdateAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.CosmosDB.CosmosDBFirewallRuleData data, System.Threading.CancellationToken cancellationToken = default);
abstract member UpdateAsync : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.CosmosDBFirewallRuleData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBFirewallRuleResource>>
override this.UpdateAsync : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.CosmosDBFirewallRuleData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBFirewallRuleResource>>
Public Overridable Function UpdateAsync (waitUntil As WaitUntil, 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.

data
CosmosDBFirewallRuleData

The required parameters for creating or updating a firewall rule.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

data is null.

Applies to