Clusters interface

Paket:

@azure/arm-cosmosdbforpostgresql

Antarmuka yang mewakili Kluster.

Metode

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)	Membuat kluster baru dengan server.
beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)	Membuat kluster baru dengan server.
beginDelete(string, string, ClustersDeleteOptionalParams)	Menghapus kluster bersama dengan server di dalamnya.
beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)	Menghapus kluster bersama dengan server di dalamnya.
beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)	Mempromosikan kluster replika baca ke kluster baca-tulis independen.
beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)	Mempromosikan kluster replika baca ke kluster baca-tulis independen.
beginRestart(string, string, ClustersRestartOptionalParams)	Memulai ulang semua simpul dalam kluster.
beginRestartAndWait(string, string, ClustersRestartOptionalParams)	Memulai ulang semua simpul dalam kluster.
beginStart(string, string, ClustersStartOptionalParams)	Mulai menghentikan komputasi pada semua node kluster.
beginStartAndWait(string, string, ClustersStartOptionalParams)	Mulai menghentikan komputasi pada semua node kluster.
beginStop(string, string, ClustersStopOptionalParams)	Menghentikan komputasi pada semua node kluster.
beginStopAndWait(string, string, ClustersStopOptionalParams)	Menghentikan komputasi pada semua node kluster.
beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	Memperbarui kluster yang ada. Isi permintaan dapat berisi satu atau beberapa properti dari definisi kluster.
beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	Memperbarui kluster yang ada. Isi permintaan dapat berisi satu atau beberapa properti dari definisi kluster.
checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)	Memeriksa ketersediaan nama kluster. Nama kluster harus unik secara global; setidaknya 3 karakter dan paling banyak 40 karakter; mereka hanya boleh berisi huruf kecil, angka, dan tanda hubung; dan tidak boleh dimulai atau diakhir dengan tanda hubung.
get(string, string, ClustersGetOptionalParams)	Mendapatkan informasi tentang kluster seperti konfigurasi komputasi dan penyimpanan dan metadata siklus hidup kluster seperti tanggal dan waktu pembuatan kluster.
list(ClustersListOptionalParams)	Mencantumkan semua kluster dalam langganan.
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)	Mencantumkan semua kluster dalam grup sumber daya.

Detail Metode

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)

Membuat kluster baru dengan server.

function beginCreate(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

clusterName

string

Nama kluster.

parameters

Cluster

Parameter yang diperlukan untuk membuat atau memperbarui kluster.

options

ClustersCreateOptionalParams

Parameter opsi.

Mengembalikan

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)

Membuat kluster baru dengan server.

function beginCreateAndWait(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOptionalParams): Promise<Cluster>

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

clusterName

string

Nama kluster.

parameters

Cluster

Parameter yang diperlukan untuk membuat atau memperbarui kluster.

options

ClustersCreateOptionalParams

Parameter opsi.

Mengembalikan

Promise<Cluster>

beginDelete(string, string, ClustersDeleteOptionalParams)

Menghapus kluster bersama dengan server di dalamnya.

function beginDelete(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

clusterName

string

Nama kluster.

options

ClustersDeleteOptionalParams

Parameter opsi.

Mengembalikan

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

Menghapus kluster bersama dengan server di dalamnya.

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<void>

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

clusterName

string

Nama kluster.

options

ClustersDeleteOptionalParams

Parameter opsi.

Mengembalikan

Promise<void>

beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)

Mempromosikan kluster replika baca ke kluster baca-tulis independen.

function beginPromoteReadReplica(resourceGroupName: string, clusterName: string, options?: ClustersPromoteReadReplicaOptionalParams): Promise<SimplePollerLike<OperationState<ClustersPromoteReadReplicaHeaders>, ClustersPromoteReadReplicaHeaders>>

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

clusterName

string

Nama kluster.

options

ClustersPromoteReadReplicaOptionalParams

Parameter opsi.

Mengembalikan

Promise<@azure/core-lro.SimplePollerLike<OperationState<ClustersPromoteReadReplicaHeaders>, ClustersPromoteReadReplicaHeaders>>

beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)

Mempromosikan kluster replika baca ke kluster baca-tulis independen.

function beginPromoteReadReplicaAndWait(resourceGroupName: string, clusterName: string, options?: ClustersPromoteReadReplicaOptionalParams): Promise<ClustersPromoteReadReplicaHeaders>

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

clusterName

string

Nama kluster.

options

ClustersPromoteReadReplicaOptionalParams

Parameter opsi.

Mengembalikan

Promise<ClustersPromoteReadReplicaHeaders>

beginRestart(string, string, ClustersRestartOptionalParams)

Memulai ulang semua simpul dalam kluster.

function beginRestart(resourceGroupName: string, clusterName: string, options?: ClustersRestartOptionalParams): Promise<SimplePollerLike<OperationState<ClustersRestartHeaders>, ClustersRestartHeaders>>

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

clusterName

string

Nama kluster.

options

ClustersRestartOptionalParams

Parameter opsi.

Mengembalikan

Promise<@azure/core-lro.SimplePollerLike<OperationState<ClustersRestartHeaders>, ClustersRestartHeaders>>

beginRestartAndWait(string, string, ClustersRestartOptionalParams)

Memulai ulang semua simpul dalam kluster.

function beginRestartAndWait(resourceGroupName: string, clusterName: string, options?: ClustersRestartOptionalParams): Promise<ClustersRestartHeaders>

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

clusterName

string

Nama kluster.

options

ClustersRestartOptionalParams

Parameter opsi.

Mengembalikan

Promise<ClustersRestartHeaders>

beginStart(string, string, ClustersStartOptionalParams)

Mulai menghentikan komputasi pada semua node kluster.

function beginStart(resourceGroupName: string, clusterName: string, options?: ClustersStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

clusterName

string

Nama kluster.

options

ClustersStartOptionalParams

Parameter opsi.

Mengembalikan

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStartAndWait(string, string, ClustersStartOptionalParams)

Mulai menghentikan komputasi pada semua node kluster.

function beginStartAndWait(resourceGroupName: string, clusterName: string, options?: ClustersStartOptionalParams): Promise<void>

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

clusterName

string

Nama kluster.

options

ClustersStartOptionalParams

Parameter opsi.

Mengembalikan

Promise<void>

beginStop(string, string, ClustersStopOptionalParams)

Menghentikan komputasi pada semua node kluster.

function beginStop(resourceGroupName: string, clusterName: string, options?: ClustersStopOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

clusterName

string

Nama kluster.

options

ClustersStopOptionalParams

Parameter opsi.

Mengembalikan

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStopAndWait(string, string, ClustersStopOptionalParams)

Menghentikan komputasi pada semua node kluster.

function beginStopAndWait(resourceGroupName: string, clusterName: string, options?: ClustersStopOptionalParams): Promise<void>

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

clusterName

string

Nama kluster.

options

ClustersStopOptionalParams

Parameter opsi.

Mengembalikan

Promise<void>

beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

Memperbarui kluster yang ada. Isi permintaan dapat berisi satu atau beberapa properti dari definisi kluster.

function beginUpdate(resourceGroupName: string, clusterName: string, parameters: ClusterForUpdate, options?: ClustersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

clusterName

string

Nama kluster.

parameters

ClusterForUpdate

Parameter untuk memperbarui kluster.

options

ClustersUpdateOptionalParams

Parameter opsi.

Mengembalikan

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

Memperbarui kluster yang ada. Isi permintaan dapat berisi satu atau beberapa properti dari definisi kluster.

function beginUpdateAndWait(resourceGroupName: string, clusterName: string, parameters: ClusterForUpdate, options?: ClustersUpdateOptionalParams): Promise<Cluster>

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

clusterName

string

Nama kluster.

parameters

ClusterForUpdate

Parameter untuk memperbarui kluster.

options

ClustersUpdateOptionalParams

Parameter opsi.

Mengembalikan

Promise<Cluster>

checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)

Memeriksa ketersediaan nama kluster. Nama kluster harus unik secara global; setidaknya 3 karakter dan paling banyak 40 karakter; mereka hanya boleh berisi huruf kecil, angka, dan tanda hubung; dan tidak boleh dimulai atau diakhir dengan tanda hubung.

function checkNameAvailability(nameAvailabilityRequest: NameAvailabilityRequest, options?: ClustersCheckNameAvailabilityOptionalParams): Promise<NameAvailability>

Parameter

nameAvailabilityRequest

NameAvailabilityRequest

Parameter yang diperlukan untuk memeriksa apakah nama kluster tersedia.

options

ClustersCheckNameAvailabilityOptionalParams

Parameter opsi.

Mengembalikan

Promise<NameAvailability>

get(string, string, ClustersGetOptionalParams)

Mendapatkan informasi tentang kluster seperti konfigurasi komputasi dan penyimpanan dan metadata siklus hidup kluster seperti tanggal dan waktu pembuatan kluster.

function get(resourceGroupName: string, clusterName: string, options?: ClustersGetOptionalParams): Promise<Cluster>

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

clusterName

string

Nama kluster.

options

ClustersGetOptionalParams

Parameter opsi.

Mengembalikan

Promise<Cluster>

list(ClustersListOptionalParams)

Mencantumkan semua kluster dalam langganan.

function list(options?: ClustersListOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

Parameter

options

ClustersListOptionalParams

Parameter opsi.

Mengembalikan

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

Mencantumkan semua kluster dalam grup sumber daya.

function listByResourceGroup(resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

options

ClustersListByResourceGroupOptionalParams

Parameter opsi.

Mengembalikan

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>