Table of Contents

Interface IPrivateEndpointConnectionsOperations

Namespace
Microsoft.Azure.Management.CosmosDB.Fluent
Assembly
Microsoft.Azure.Management.CosmosDB.Fluent.dll

PrivateEndpointConnectionsOperations operations.

public interface IPrivateEndpointConnectionsOperations
Extension Methods

Methods

BeginCreateOrUpdateWithHttpMessagesAsync(string, string, string, PrivateEndpointConnectionInner, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<PrivateEndpointConnectionInner>> BeginCreateOrUpdateWithHttpMessagesAsync(string resourceGroupName, string accountName, string privateEndpointConnectionName, PrivateEndpointConnectionInner parameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

The name of the resource group. The name is case insensitive.

accountName string

Cosmos DB database account name.

privateEndpointConnectionName string

The name of the private endpoint connection.

parameters PrivateEndpointConnectionInner
customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<PrivateEndpointConnectionInner>>

Exceptions

ErrorResponseException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

BeginDeleteWithHttpMessagesAsync(string, string, string, Dictionary<string, List<string>>, CancellationToken)

Deletes a private endpoint connection with a given name.

Task<AzureOperationResponse> BeginDeleteWithHttpMessagesAsync(string resourceGroupName, string accountName, string privateEndpointConnectionName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

The name of the resource group. The name is case insensitive.

accountName string

Cosmos DB database account name.

privateEndpointConnectionName string

The name of the private endpoint connection.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

ErrorResponseException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

CreateOrUpdateWithHttpMessagesAsync(string, string, string, PrivateEndpointConnectionInner, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<PrivateEndpointConnectionInner>> CreateOrUpdateWithHttpMessagesAsync(string resourceGroupName, string accountName, string privateEndpointConnectionName, PrivateEndpointConnectionInner parameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

The name of the resource group. The name is case insensitive.

accountName string

Cosmos DB database account name.

privateEndpointConnectionName string

The name of the private endpoint connection.

parameters PrivateEndpointConnectionInner
customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<PrivateEndpointConnectionInner>>

Exceptions

ErrorResponseException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

DeleteWithHttpMessagesAsync(string, string, string, Dictionary<string, List<string>>, CancellationToken)

Deletes a private endpoint connection with a given name.

Task<AzureOperationResponse> DeleteWithHttpMessagesAsync(string resourceGroupName, string accountName, string privateEndpointConnectionName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

The name of the resource group. The name is case insensitive.

accountName string

Cosmos DB database account name.

privateEndpointConnectionName string

The name of the private endpoint connection.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

ErrorResponseException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

GetWithHttpMessagesAsync(string, string, string, Dictionary<string, List<string>>, CancellationToken)

Gets a private endpoint connection.

Task<AzureOperationResponse<PrivateEndpointConnectionInner>> GetWithHttpMessagesAsync(string resourceGroupName, string accountName, string privateEndpointConnectionName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

The name of the resource group. The name is case insensitive.

accountName string

Cosmos DB database account name.

privateEndpointConnectionName string

The name of the private endpoint connection.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<PrivateEndpointConnectionInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

ListByDatabaseAccountWithHttpMessagesAsync(string, string, Dictionary<string, List<string>>, CancellationToken)

List all private endpoint connections on a Cosmos DB account.

Task<AzureOperationResponse<IEnumerable<PrivateEndpointConnectionInner>>> ListByDatabaseAccountWithHttpMessagesAsync(string resourceGroupName, string accountName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

The name of the resource group. The name is case insensitive.

accountName string

Cosmos DB database account name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IEnumerable<PrivateEndpointConnectionInner>>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null