CosmosDBPrivateLinkResourceCollection Class

Definition

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

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

Constructors

CosmosDBPrivateLinkResourceCollection()

Initializes a new instance of the CosmosDBPrivateLinkResourceCollection 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

Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

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

Checks to see if the resource exists in azure.

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

Gets the private link resources that need to be created for a Cosmos DB account.

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

Gets the private link resources that need to be created for a Cosmos DB account.

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

Gets the private link resources that need to be created for a Cosmos DB account.

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

Gets the private link resources that need to be created for a Cosmos DB account.

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

Tries to get details for this resource from the service.

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

Tries to get details for this resource from the service.

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

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<CosmosDBPrivateLinkResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to