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>