MongoClustersOperations interface
Interfaz que representa las operaciones de MongoClusters.
Propiedades
| check |
Compruebe si el nombre del clúster de Mongo está disponible para su uso. |
| create |
Cree o actualice un clúster de Mongo. La actualización sobrescribe todas las propiedades del recurso. Para modificar solo algunas de las propiedades, use PATCH. |
| delete | |
| get | Obtiene información sobre un clúster de Mongo. |
| list | Enumere todos los clústeres de mongo en una suscripción determinada. |
| list |
Enumere todos los clústeres de mongo de un grupo de recursos determinado. |
| list |
Enumere las cadenas de conexión del clúster de mongo. Esto incluye la cadena de conexión predeterminada mediante SCRAM-SHA-256, así como otras cadenas de conexión admitidas por el clúster. |
| promote | Promueve un clúster de mongo de réplica a un rol principal. |
| update | Actualiza un clúster de Mongo existente. El cuerpo de la solicitud puede contener una a muchas de las propiedades presentes en la definición normal del clúster de Mongo. |
Detalles de las propiedades
checkNameAvailability
Compruebe si el nombre del clúster de Mongo está disponible para su uso.
checkNameAvailability: (location: string, body: CheckNameAvailabilityRequest, options?: MongoClustersCheckNameAvailabilityOptionalParams) => Promise<CheckNameAvailabilityResponse>
Valor de propiedad
(location: string, body: CheckNameAvailabilityRequest, options?: MongoClustersCheckNameAvailabilityOptionalParams) => Promise<CheckNameAvailabilityResponse>
createOrUpdate
Cree o actualice un clúster de Mongo. La actualización sobrescribe todas las propiedades del recurso. Para modificar solo algunas de las propiedades, use PATCH.
createOrUpdate: (resourceGroupName: string, mongoClusterName: string, resource: MongoCluster, options?: MongoClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<MongoCluster>, MongoCluster>
Valor de propiedad
(resourceGroupName: string, mongoClusterName: string, resource: MongoCluster, options?: MongoClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<MongoCluster>, MongoCluster>
delete
delete: (resourceGroupName: string, mongoClusterName: string, options?: MongoClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>
Valor de propiedad
(resourceGroupName: string, mongoClusterName: string, options?: MongoClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>
get
Obtiene información sobre un clúster de Mongo.
get: (resourceGroupName: string, mongoClusterName: string, options?: MongoClustersGetOptionalParams) => Promise<MongoCluster>
Valor de propiedad
(resourceGroupName: string, mongoClusterName: string, options?: MongoClustersGetOptionalParams) => Promise<MongoCluster>
list
Enumere todos los clústeres de mongo en una suscripción determinada.
list: (options?: MongoClustersListOptionalParams) => PagedAsyncIterableIterator<MongoCluster, MongoCluster[], PageSettings>
Valor de propiedad
(options?: MongoClustersListOptionalParams) => PagedAsyncIterableIterator<MongoCluster, MongoCluster[], PageSettings>
listByResourceGroup
Enumere todos los clústeres de mongo de un grupo de recursos determinado.
listByResourceGroup: (resourceGroupName: string, options?: MongoClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<MongoCluster, MongoCluster[], PageSettings>
Valor de propiedad
(resourceGroupName: string, options?: MongoClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<MongoCluster, MongoCluster[], PageSettings>
listConnectionStrings
Enumere las cadenas de conexión del clúster de mongo. Esto incluye la cadena de conexión predeterminada mediante SCRAM-SHA-256, así como otras cadenas de conexión admitidas por el clúster.
listConnectionStrings: (resourceGroupName: string, mongoClusterName: string, options?: MongoClustersListConnectionStringsOptionalParams) => Promise<ListConnectionStringsResult>
Valor de propiedad
(resourceGroupName: string, mongoClusterName: string, options?: MongoClustersListConnectionStringsOptionalParams) => Promise<ListConnectionStringsResult>
promote
Promueve un clúster de mongo de réplica a un rol principal.
promote: (resourceGroupName: string, mongoClusterName: string, body: PromoteReplicaRequest, options?: MongoClustersPromoteOptionalParams) => PollerLike<OperationState<void>, void>
Valor de propiedad
(resourceGroupName: string, mongoClusterName: string, body: PromoteReplicaRequest, options?: MongoClustersPromoteOptionalParams) => PollerLike<OperationState<void>, void>
update
Actualiza un clúster de Mongo existente. El cuerpo de la solicitud puede contener una a muchas de las propiedades presentes en la definición normal del clúster de Mongo.
update: (resourceGroupName: string, mongoClusterName: string, properties: MongoClusterUpdate, options?: MongoClustersUpdateOptionalParams) => PollerLike<OperationState<MongoCluster>, MongoCluster>
Valor de propiedad
(resourceGroupName: string, mongoClusterName: string, properties: MongoClusterUpdate, options?: MongoClustersUpdateOptionalParams) => PollerLike<OperationState<MongoCluster>, MongoCluster>