CosmosDBForPostgreSQL class

Package:

@azure/arm-cosmosdbforpostgresql

Extends

ServiceClient

Constructors

CosmosDBForPostgreSQL(TokenCredential, string, CosmosDBForPostgreSQLOptionalParams)

Initializes a new instance of the CosmosDBForPostgreSQL class.

Properties

$host
apiVersion
clusters
configurations
firewallRules
operations
privateEndpointConnections
privateLinkResources
roles
servers
subscriptionId

Inherited Properties

pipeline

The pipeline used by this client to make requests

Inherited Methods

sendOperationRequest<T>(OperationArguments, OperationSpec)	Send an HTTP request that is populated using the provided OperationSpec.
sendRequest(PipelineRequest)	Send the provided httpRequest.

Constructor Details

CosmosDBForPostgreSQL(TokenCredential, string, CosmosDBForPostgreSQLOptionalParams)

Initializes a new instance of the CosmosDBForPostgreSQL class.

new CosmosDBForPostgreSQL(credentials: TokenCredential, subscriptionId: string, options?: CosmosDBForPostgreSQLOptionalParams)

Parameters

credentials

TokenCredential

Subscription credentials which uniquely identify client subscription.

subscriptionId

string

The ID of the target subscription. The value must be an UUID.

options

CosmosDBForPostgreSQLOptionalParams

The parameter options

Property Details

$host

$host: string

Property Value

string

apiVersion

apiVersion: string

Property Value

string

clusters

clusters: Clusters

Property Value

Clusters

configurations

configurations: Configurations

Property Value

Configurations

firewallRules

firewallRules: FirewallRules

Property Value

FirewallRules

operations

operations: Operations

Property Value

Operations

privateEndpointConnections

privateEndpointConnections: PrivateEndpointConnections

Property Value

PrivateEndpointConnections

privateLinkResources

privateLinkResources: PrivateLinkResources

Property Value

PrivateLinkResources

roles

roles: Roles

Property Value

Roles

servers

servers: Servers

Property Value

Servers

subscriptionId

subscriptionId: string

Property Value

string

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Pipeline

Inherited From coreClient.ServiceClient.pipeline

Inherited Method Details

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>

Parameters

operationArguments

OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec

OperationSpec

The OperationSpec to use to populate the httpRequest.

Returns

Promise<T>

Inherited From coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Send the provided httpRequest.

function sendRequest(request: PipelineRequest): Promise<PipelineResponse>

Parameters

request

PipelineRequest

Returns

Promise<PipelineResponse>

Inherited From coreClient.ServiceClient.sendRequest