MongoDBUserDefinitionCollection Class

Definition

A class representing a collection of MongoDBUserDefinitionResource and their operations. Each MongoDBUserDefinitionResource in the collection will belong to the same instance of CosmosDBAccountResource. To get a MongoDBUserDefinitionCollection instance call the GetMongoDBUserDefinitions method from an instance of CosmosDBAccountResource.

public class MongoDBUserDefinitionCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.CosmosDB.MongoDBUserDefinitionResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.MongoDBUserDefinitionResource>
type MongoDBUserDefinitionCollection = class
    inherit ArmCollection
    interface seq<MongoDBUserDefinitionResource>
    interface IEnumerable
    interface IAsyncEnumerable<MongoDBUserDefinitionResource>
Public Class MongoDBUserDefinitionCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of MongoDBUserDefinitionResource), IEnumerable(Of MongoDBUserDefinitionResource)
Inheritance
MongoDBUserDefinitionCollection
Implements

Constructors

MongoDBUserDefinitionCollection()

Initializes a new instance of the MongoDBUserDefinitionCollection 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, MongoDBUserDefinitionCreateOrUpdateContent, CancellationToken)

Creates or updates an Azure Cosmos DB Mongo User Definition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}
  • Operation Id: MongoDBResources_CreateUpdateMongoUserDefinition
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBUserDefinitionResource
CreateOrUpdateAsync(WaitUntil, String, MongoDBUserDefinitionCreateOrUpdateContent, CancellationToken)

Creates or updates an Azure Cosmos DB Mongo User Definition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}
  • Operation Id: MongoDBResources_CreateUpdateMongoUserDefinition
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBUserDefinitionResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}
  • Operation Id: MongoDBResources_GetMongoUserDefinition
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBUserDefinitionResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}
  • Operation Id: MongoDBResources_GetMongoUserDefinition
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBUserDefinitionResource
Get(String, CancellationToken)

Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}
  • Operation Id: MongoDBResources_GetMongoUserDefinition
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBUserDefinitionResource
GetAll(CancellationToken)

Retrieves the list of all Azure Cosmos DB Mongo User Definition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions
  • Operation Id: MongoDBResources_ListMongoUserDefinitions
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBUserDefinitionResource
GetAllAsync(CancellationToken)

Retrieves the list of all Azure Cosmos DB Mongo User Definition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions
  • Operation Id: MongoDBResources_ListMongoUserDefinitions
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBUserDefinitionResource
GetAsync(String, CancellationToken)

Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}
  • Operation Id: MongoDBResources_GetMongoUserDefinition
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBUserDefinitionResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}
  • Operation Id: MongoDBResources_GetMongoUserDefinition
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBUserDefinitionResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}
  • Operation Id: MongoDBResources_GetMongoUserDefinition
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBUserDefinitionResource
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<MongoDBUserDefinitionResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<MongoDBUserDefinitionResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to