Clusters interface

الحزمة:

@azure/arm-cosmosdbforpostgresql

واجهة تمثل مجموعات.

الأساليب

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)	إنشاء نظام مجموعة جديد مع خوادم.
beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)	إنشاء نظام مجموعة جديد مع خوادم.
beginDelete(string, string, ClustersDeleteOptionalParams)	حذف مجموعة مع خوادم فيها.
beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)	حذف مجموعة مع خوادم فيها.
beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)	ترقية مجموعة النسخ المتماثلة للقراءة إلى مجموعة قراءة وكتابة مستقلة.
beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)	ترقية مجموعة النسخ المتماثلة للقراءة إلى مجموعة قراءة وكتابة مستقلة.
beginRestart(string, string, ClustersRestartOptionalParams)	إعادة تشغيل كافة العقد في نظام المجموعة.
beginRestartAndWait(string, string, ClustersRestartOptionalParams)	إعادة تشغيل كافة العقد في نظام المجموعة.
beginStart(string, string, ClustersStartOptionalParams)	بدء الحوسبة المتوقفة على جميع عقد نظام المجموعة.
beginStartAndWait(string, string, ClustersStartOptionalParams)	بدء الحوسبة المتوقفة على جميع عقد نظام المجموعة.
beginStop(string, string, ClustersStopOptionalParams)	إيقاف الحساب على جميع عقد نظام المجموعة.
beginStopAndWait(string, string, ClustersStopOptionalParams)	إيقاف الحساب على جميع عقد نظام المجموعة.
beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	تحديث نظام مجموعة موجود. يمكن أن يحتوي نص الطلب على خاصية واحدة أو عدة خصائص من تعريف نظام المجموعة.
beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	تحديث نظام مجموعة موجود. يمكن أن يحتوي نص الطلب على خاصية واحدة أو عدة خصائص من تعريف نظام المجموعة.
checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)	التحقق من توفر اسم نظام المجموعة. يجب أن تكون أسماء نظام المجموعة فريدة عالميا؛ 3 أحرف على الأقل و40 حرفا على الأكثر؛ يجب أن تحتوي فقط على أحرف صغيرة وأرقام وواصلات؛ ويجب ألا تبدأ أو تنتهي بواصلة.
get(string, string, ClustersGetOptionalParams)	يحصل على معلومات حول مجموعة مثل تكوين الحوسبة والتخزين وبيانات تعريف دورة حياة نظام المجموعة مثل تاريخ ووقت إنشاء نظام المجموعة.
list(ClustersListOptionalParams)	يسرد كافة المجموعات في اشتراك.
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)	يسرد كافة المجموعات في مجموعة موارد.

تفاصيل الأسلوب

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)

إنشاء نظام مجموعة جديد مع خوادم.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

clusterName

string

اسم نظام المجموعة.

parameters

Cluster

المعلمات المطلوبة لإنشاء نظام مجموعة أو تحديثه.

options

ClustersCreateOptionalParams

معلمات الخيارات.

المرتجعات

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

beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)

إنشاء نظام مجموعة جديد مع خوادم.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

clusterName

string

اسم نظام المجموعة.

parameters

Cluster

المعلمات المطلوبة لإنشاء نظام مجموعة أو تحديثه.

options

ClustersCreateOptionalParams

معلمات الخيارات.

المرتجعات

Promise<Cluster>

beginDelete(string, string, ClustersDeleteOptionalParams)

حذف مجموعة مع خوادم فيها.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

clusterName

string

اسم نظام المجموعة.

options

ClustersDeleteOptionalParams

معلمات الخيارات.

المرتجعات

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

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

حذف مجموعة مع خوادم فيها.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

clusterName

string

اسم نظام المجموعة.

options

ClustersDeleteOptionalParams

معلمات الخيارات.

المرتجعات

Promise<void>

beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)

ترقية مجموعة النسخ المتماثلة للقراءة إلى مجموعة قراءة وكتابة مستقلة.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

clusterName

string

اسم نظام المجموعة.

options

ClustersPromoteReadReplicaOptionalParams

معلمات الخيارات.

المرتجعات

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

beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)

ترقية مجموعة النسخ المتماثلة للقراءة إلى مجموعة قراءة وكتابة مستقلة.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

clusterName

string

اسم نظام المجموعة.

options

ClustersPromoteReadReplicaOptionalParams

معلمات الخيارات.

المرتجعات

Promise<ClustersPromoteReadReplicaHeaders>

beginRestart(string, string, ClustersRestartOptionalParams)

إعادة تشغيل كافة العقد في نظام المجموعة.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

clusterName

string

اسم نظام المجموعة.

options

ClustersRestartOptionalParams

معلمات الخيارات.

المرتجعات

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

beginRestartAndWait(string, string, ClustersRestartOptionalParams)

إعادة تشغيل كافة العقد في نظام المجموعة.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

clusterName

string

اسم نظام المجموعة.

options

ClustersRestartOptionalParams

معلمات الخيارات.

المرتجعات

Promise<ClustersRestartHeaders>

beginStart(string, string, ClustersStartOptionalParams)

بدء الحوسبة المتوقفة على جميع عقد نظام المجموعة.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

clusterName

string

اسم نظام المجموعة.

options

ClustersStartOptionalParams

معلمات الخيارات.

المرتجعات

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

beginStartAndWait(string, string, ClustersStartOptionalParams)

بدء الحوسبة المتوقفة على جميع عقد نظام المجموعة.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

clusterName

string

اسم نظام المجموعة.

options

ClustersStartOptionalParams

معلمات الخيارات.

المرتجعات

Promise<void>

beginStop(string, string, ClustersStopOptionalParams)

إيقاف الحساب على جميع عقد نظام المجموعة.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

clusterName

string

اسم نظام المجموعة.

options

ClustersStopOptionalParams

معلمات الخيارات.

المرتجعات

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

beginStopAndWait(string, string, ClustersStopOptionalParams)

إيقاف الحساب على جميع عقد نظام المجموعة.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

clusterName

string

اسم نظام المجموعة.

options

ClustersStopOptionalParams

معلمات الخيارات.

المرتجعات

Promise<void>

beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

تحديث نظام مجموعة موجود. يمكن أن يحتوي نص الطلب على خاصية واحدة أو عدة خصائص من تعريف نظام المجموعة.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

clusterName

string

اسم نظام المجموعة.

parameters

ClusterForUpdate

معلمات تحديث نظام مجموعة.

options

ClustersUpdateOptionalParams

معلمات الخيارات.

المرتجعات

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

beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

تحديث نظام مجموعة موجود. يمكن أن يحتوي نص الطلب على خاصية واحدة أو عدة خصائص من تعريف نظام المجموعة.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

clusterName

string

اسم نظام المجموعة.

parameters

ClusterForUpdate

معلمات تحديث نظام مجموعة.

options

ClustersUpdateOptionalParams

معلمات الخيارات.

المرتجعات

Promise<Cluster>

checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)

التحقق من توفر اسم نظام المجموعة. يجب أن تكون أسماء نظام المجموعة فريدة عالميا؛ 3 أحرف على الأقل و40 حرفا على الأكثر؛ يجب أن تحتوي فقط على أحرف صغيرة وأرقام وواصلات؛ ويجب ألا تبدأ أو تنتهي بواصلة.

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

المعلمات

nameAvailabilityRequest

NameAvailabilityRequest

المعلمات المطلوبة للتحقق مما إذا كان اسم نظام المجموعة متوفرا.

options

ClustersCheckNameAvailabilityOptionalParams

معلمات الخيارات.

المرتجعات

Promise<NameAvailability>

get(string, string, ClustersGetOptionalParams)

يحصل على معلومات حول مجموعة مثل تكوين الحوسبة والتخزين وبيانات تعريف دورة حياة نظام المجموعة مثل تاريخ ووقت إنشاء نظام المجموعة.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

clusterName

string

اسم نظام المجموعة.

options

ClustersGetOptionalParams

معلمات الخيارات.

المرتجعات

Promise<Cluster>

list(ClustersListOptionalParams)

يسرد كافة المجموعات في اشتراك.

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

المعلمات

options

ClustersListOptionalParams

معلمات الخيارات.

المرتجعات

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

يسرد كافة المجموعات في مجموعة موارد.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

options

ClustersListByResourceGroupOptionalParams

معلمات الخيارات.

المرتجعات

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>