CosmosDBManagementClient class

Extends

Constructors

CosmosDBManagementClient(TokenCredential, string, CosmosDBManagementClientOptionalParams)

Initializes a new instance of the CosmosDBManagementClient class.

Properties

$host
apiVersion
cassandraClusters
cassandraDataCenters
cassandraResources
collection
collectionPartition
collectionPartitionRegion
collectionRegion
database
databaseAccountRegion
databaseAccounts
gremlinResources
locations
mongoDBResources
notebookWorkspaces
operations
partitionKeyRangeId
partitionKeyRangeIdRegion
percentile
percentileSourceTarget
percentileTarget
privateEndpointConnections
privateLinkResources
restorableDatabaseAccounts
restorableGremlinDatabases
restorableGremlinGraphs
restorableGremlinResources
restorableMongodbCollections
restorableMongodbDatabases
restorableMongodbResources
restorableSqlContainers
restorableSqlDatabases
restorableSqlResources
restorableTableResources
restorableTables
service
sqlResources
subscriptionId
tableResources

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

CosmosDBManagementClient(TokenCredential, string, CosmosDBManagementClientOptionalParams)

Initializes a new instance of the CosmosDBManagementClient class.

new CosmosDBManagementClient(credentials: TokenCredential, subscriptionId: string, options?: CosmosDBManagementClientOptionalParams)

Parameters

credentials
TokenCredential

Subscription credentials which uniquely identify client subscription.

subscriptionId

string

The ID of the target subscription.

options
CosmosDBManagementClientOptionalParams

The parameter options

Property Details

$host

$host: string

Property Value

string

apiVersion

apiVersion: string

Property Value

string

cassandraClusters

cassandraClusters: CassandraClusters

Property Value

cassandraDataCenters

cassandraDataCenters: CassandraDataCenters

Property Value

cassandraResources

cassandraResources: CassandraResources

Property Value

collection

collection: Collection

Property Value

collectionPartition

collectionPartition: CollectionPartition

Property Value

collectionPartitionRegion

collectionPartitionRegion: CollectionPartitionRegion

Property Value

collectionRegion

collectionRegion: CollectionRegion

Property Value

database

database: Database

Property Value

databaseAccountRegion

databaseAccountRegion: DatabaseAccountRegion

Property Value

databaseAccounts

databaseAccounts: DatabaseAccounts

Property Value

gremlinResources

gremlinResources: GremlinResources

Property Value

locations

locations: Locations

Property Value

mongoDBResources

mongoDBResources: MongoDBResources

Property Value

notebookWorkspaces

notebookWorkspaces: NotebookWorkspaces

Property Value

operations

operations: Operations

Property Value

partitionKeyRangeId

partitionKeyRangeId: PartitionKeyRangeId

Property Value

partitionKeyRangeIdRegion

partitionKeyRangeIdRegion: PartitionKeyRangeIdRegion

Property Value

percentile

percentile: Percentile

Property Value

percentileSourceTarget

percentileSourceTarget: PercentileSourceTarget

Property Value

percentileTarget

percentileTarget: PercentileTarget

Property Value

privateEndpointConnections

privateEndpointConnections: PrivateEndpointConnections

Property Value

privateLinkResources

privateLinkResources: PrivateLinkResources

Property Value

restorableDatabaseAccounts

restorableDatabaseAccounts: RestorableDatabaseAccounts

Property Value

restorableGremlinDatabases

restorableGremlinDatabases: RestorableGremlinDatabases

Property Value

restorableGremlinGraphs

restorableGremlinGraphs: RestorableGremlinGraphs

Property Value

restorableGremlinResources

restorableGremlinResources: RestorableGremlinResources

Property Value

restorableMongodbCollections

restorableMongodbCollections: RestorableMongodbCollections

Property Value

restorableMongodbDatabases

restorableMongodbDatabases: RestorableMongodbDatabases

Property Value

restorableMongodbResources

restorableMongodbResources: RestorableMongodbResources

Property Value

restorableSqlContainers

restorableSqlContainers: RestorableSqlContainers

Property Value

restorableSqlDatabases

restorableSqlDatabases: RestorableSqlDatabases

Property Value

restorableSqlResources

restorableSqlResources: RestorableSqlResources

Property Value

restorableTableResources

restorableTableResources: RestorableTableResources

Property Value

restorableTables

restorableTables: RestorableTables

Property Value

service

service: Service

Property Value

sqlResources

sqlResources: SqlResources

Property Value

subscriptionId

subscriptionId: string

Property Value

string

tableResources

tableResources: TableResources

Property Value

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

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