CosmosDBPrivateEndpointConnectionCollection Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.CosmosDB
Assembly:
Azure.ResourceManager.CosmosDB.dll
Package:
Azure.ResourceManager.CosmosDB v1.3.2
Package:
Azure.ResourceManager.CosmosDB v1.4.0-beta.11
Source:
CosmosDBPrivateEndpointConnectionCollection.cs
Source:
CosmosDBPrivateEndpointConnectionCollection.cs

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

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

Constructors

CosmosDBPrivateEndpointConnectionCollection()

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

Approve or reject a private endpoint connection with a given name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation Id: PrivateEndpointConnections_CreateOrUpdate
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBPrivateEndpointConnectionResource
CreateOrUpdateAsync(WaitUntil, String, CosmosDBPrivateEndpointConnectionData, CancellationToken)

Approve or reject a private endpoint connection with a given name.

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

Checks to see if the resource exists in azure.

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

Checks to see if the resource exists in azure.

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

Gets a private endpoint connection.

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

List all private endpoint connections on a Cosmos DB account.

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

List all private endpoint connections on a Cosmos DB account.

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

Gets a private endpoint connection.

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

Tries to get details for this resource from the service.

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

Tries to get details for this resource from the service.

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

Returns an enumerator that iterates asynchronously through the collection.
IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.
IEnumerable<CosmosDBPrivateEndpointConnectionResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to