CosmosDBFirewallRuleCollection Class

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

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

Source:

CosmosDBFirewallRuleCollection.cs

A class representing a collection of CosmosDBFirewallRuleResource and their operations. Each CosmosDBFirewallRuleResource in the collection will belong to the same instance of MongoClusterResource. To get a CosmosDBFirewallRuleCollection instance call the GetCosmosDBFirewallRules method from an instance of MongoClusterResource.

public class CosmosDBFirewallRuleCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.CosmosDB.CosmosDBFirewallRuleResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.CosmosDBFirewallRuleResource>

type CosmosDBFirewallRuleCollection = class
    inherit ArmCollection
    interface seq<CosmosDBFirewallRuleResource>
    interface IEnumerable
    interface IAsyncEnumerable<CosmosDBFirewallRuleResource>

Public Class CosmosDBFirewallRuleCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of CosmosDBFirewallRuleResource), IEnumerable(Of CosmosDBFirewallRuleResource)

Inheritance

Object

ArmCollection

CosmosDBFirewallRuleCollection

Implements

IAsyncEnumerable<CosmosDBFirewallRuleResource> IEnumerable<CosmosDBFirewallRuleResource> IEnumerable

Constructors

CosmosDBFirewallRuleCollection()

Initializes a new instance of the CosmosDBFirewallRuleCollection class for mocking.

Properties

Client	Gets the ArmClient this resource client was created from. (Inherited from ArmCollection)
Diagnostics	Gets the diagnostic options for this resource client. (Inherited from ArmCollection)
Endpoint	Gets the base uri for this resource client. (Inherited from ArmCollection)
Id	Gets the resource identifier. (Inherited from ArmCollection)
Pipeline	Gets the pipeline for this resource client. (Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, String, CosmosDBFirewallRuleData, CancellationToken)	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
CreateOrUpdateAsync(WaitUntil, String, CosmosDBFirewallRuleData, CancellationToken)	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
Exists(String, CancellationToken)	Checks to see if the resource exists in azure. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules/{firewallRuleName} Operation Id: MongoClusters_GetFirewallRule Default Api Version: 2024-02-15-preview Resource: CosmosDBFirewallRuleResource
ExistsAsync(String, CancellationToken)	Checks to see if the resource exists in azure. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules/{firewallRuleName} Operation Id: MongoClusters_GetFirewallRule Default Api Version: 2024-02-15-preview Resource: CosmosDBFirewallRuleResource
Get(String, CancellationToken)	Gets information about a mongo cluster firewall rule. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules/{firewallRuleName} Operation Id: MongoClusters_GetFirewallRule Default Api Version: 2024-02-15-preview Resource: CosmosDBFirewallRuleResource
GetAll(CancellationToken)	List all the firewall rules in a given mongo cluster. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules Operation Id: MongoClusters_ListFirewallRules Default Api Version: 2024-02-15-preview Resource: CosmosDBFirewallRuleResource
GetAllAsync(CancellationToken)	List all the firewall rules in a given mongo cluster. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules Operation Id: MongoClusters_ListFirewallRules Default Api Version: 2024-02-15-preview Resource: CosmosDBFirewallRuleResource
GetAsync(String, CancellationToken)	Gets information about a mongo cluster firewall rule. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules/{firewallRuleName} Operation Id: MongoClusters_GetFirewallRule Default Api Version: 2024-02-15-preview Resource: CosmosDBFirewallRuleResource
GetIfExists(String, CancellationToken)	Tries to get details for this resource from the service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules/{firewallRuleName} Operation Id: MongoClusters_GetFirewallRule Default Api Version: 2024-02-15-preview Resource: CosmosDBFirewallRuleResource
GetIfExistsAsync(String, CancellationToken)	Tries to get details for this resource from the service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules/{firewallRuleName} Operation Id: MongoClusters_GetFirewallRule Default Api Version: 2024-02-15-preview Resource: CosmosDBFirewallRuleResource
TryGetApiVersion(ResourceType, String)	Gets the api version override if it has been set for the current client options. (Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<CosmosDBFirewallRuleResource>.GetAsyncEnumerator(CancellationToken)	Returns an enumerator that iterates asynchronously through the collection.
IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.
IEnumerable<CosmosDBFirewallRuleResource>.GetEnumerator()	Returns an enumerator that iterates through the collection.