MongoClusterResource.GetMongoClusterFirewallRuleAsync Method

Definition

Gets information about a mongo cluster firewall rule.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules/{firewallRuleName}
  • Operation Id: FirewallRules_Get
  • Default Api Version: 2024-07-01
  • Resource: MongoClusterFirewallRuleResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.MongoCluster.MongoClusterFirewallRuleResource>> GetMongoClusterFirewallRuleAsync (string firewallRuleName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetMongoClusterFirewallRuleAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.MongoCluster.MongoClusterFirewallRuleResource>>
override this.GetMongoClusterFirewallRuleAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.MongoCluster.MongoClusterFirewallRuleResource>>
Public Overridable Function GetMongoClusterFirewallRuleAsync (firewallRuleName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of MongoClusterFirewallRuleResource))

Parameters

firewallRuleName
String

The name of the mongo cluster firewall rule.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

firewallRuleName is null.

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

Applies to