Share via


CosmosDBSqlClientEncryptionKeyCollection Class

Definition

A class representing a collection of CosmosDBSqlClientEncryptionKeyResource and their operations. Each CosmosDBSqlClientEncryptionKeyResource in the collection will belong to the same instance of CosmosDBSqlDatabaseResource. To get a CosmosDBSqlClientEncryptionKeyCollection instance call the GetCosmosDBSqlClientEncryptionKeys method from an instance of CosmosDBSqlDatabaseResource.

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

Constructors

CosmosDBSqlClientEncryptionKeyCollection()

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

Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the Azure Powershell (instead of directly).

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}
  • Operation Id: SqlResources_CreateUpdateClientEncryptionKey
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBSqlClientEncryptionKeyResource
CreateOrUpdateAsync(WaitUntil, String, CosmosDBSqlClientEncryptionKeyCreateOrUpdateContent, CancellationToken)

Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the Azure Powershell (instead of directly).

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}
  • Operation Id: SqlResources_CreateUpdateClientEncryptionKey
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBSqlClientEncryptionKeyResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}
  • Operation Id: SqlResources_GetClientEncryptionKey
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBSqlClientEncryptionKeyResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}
  • Operation Id: SqlResources_GetClientEncryptionKey
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBSqlClientEncryptionKeyResource
Get(String, CancellationToken)

Gets the ClientEncryptionKey under an existing Azure Cosmos DB SQL database.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}
  • Operation Id: SqlResources_GetClientEncryptionKey
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBSqlClientEncryptionKeyResource
GetAll(CancellationToken)

Lists the ClientEncryptionKeys under an existing Azure Cosmos DB SQL database.

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

Lists the ClientEncryptionKeys under an existing Azure Cosmos DB SQL database.

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

Gets the ClientEncryptionKey under an existing Azure Cosmos DB SQL database.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}
  • Operation Id: SqlResources_GetClientEncryptionKey
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBSqlClientEncryptionKeyResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}
  • Operation Id: SqlResources_GetClientEncryptionKey
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBSqlClientEncryptionKeyResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}
  • Operation Id: SqlResources_GetClientEncryptionKey
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBSqlClientEncryptionKeyResource
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<CosmosDBSqlClientEncryptionKeyResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<CosmosDBSqlClientEncryptionKeyResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to