GarnetClustersOperations interface

Package:

@azure/arm-cosmosdb

Interface representing a GarnetClusters operations.

Properties

beginCreateUpdate
beginCreateUpdateAndWait
beginDelete
beginDeleteAndWait
beginUpdate
beginUpdateAndWait
createUpdate	Create or update a Garnet cache cluster. When updating, you must specify all writable properties.
delete
get	Get the properties of a Garnet cache cluster.
listByResourceGroup	List all Garnet clusters in this resource group.
listBySubscription	List all Garnet clusters in this subscription.
update	Updates some of the properties of a garnet cluster.

Property Details

beginCreateUpdate

Warning

This API is now deprecated.

use createUpdate instead

beginCreateUpdate: (resourceGroupName: string, clusterName: string, body: GarnetClusterResource, options?: GarnetClustersCreateUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<GarnetClusterResource>, GarnetClusterResource>>

Property Value

(resourceGroupName: string, clusterName: string, body: GarnetClusterResource, options?: GarnetClustersCreateUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<GarnetClusterResource>, GarnetClusterResource>>

beginCreateUpdateAndWait

Warning

This API is now deprecated.

use createUpdate instead

beginCreateUpdateAndWait: (resourceGroupName: string, clusterName: string, body: GarnetClusterResource, options?: GarnetClustersCreateUpdateOptionalParams) => Promise<GarnetClusterResource>

Property Value

(resourceGroupName: string, clusterName: string, body: GarnetClusterResource, options?: GarnetClustersCreateUpdateOptionalParams) => Promise<GarnetClusterResource>

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

(resourceGroupName: string, clusterName: string, options?: GarnetClustersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, clusterName: string, options?: GarnetClustersDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, clusterName: string, options?: GarnetClustersDeleteOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, clusterName: string, body: GarnetClusterResourcePatch, options?: GarnetClustersUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<GarnetClusterResource>, GarnetClusterResource>>

Property Value

(resourceGroupName: string, clusterName: string, body: GarnetClusterResourcePatch, options?: GarnetClustersUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<GarnetClusterResource>, GarnetClusterResource>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, clusterName: string, body: GarnetClusterResourcePatch, options?: GarnetClustersUpdateOptionalParams) => Promise<GarnetClusterResource>

Property Value

(resourceGroupName: string, clusterName: string, body: GarnetClusterResourcePatch, options?: GarnetClustersUpdateOptionalParams) => Promise<GarnetClusterResource>

createUpdate

Create or update a Garnet cache cluster. When updating, you must specify all writable properties.

createUpdate: (resourceGroupName: string, clusterName: string, body: GarnetClusterResource, options?: GarnetClustersCreateUpdateOptionalParams) => PollerLike<OperationState<GarnetClusterResource>, GarnetClusterResource>

Property Value

(resourceGroupName: string, clusterName: string, body: GarnetClusterResource, options?: GarnetClustersCreateUpdateOptionalParams) => PollerLike<OperationState<GarnetClusterResource>, GarnetClusterResource>

delete

delete: (resourceGroupName: string, clusterName: string, options?: GarnetClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, options?: GarnetClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Get the properties of a Garnet cache cluster.

get: (resourceGroupName: string, clusterName: string, options?: GarnetClustersGetOptionalParams) => Promise<GarnetClusterResource>

Property Value

(resourceGroupName: string, clusterName: string, options?: GarnetClustersGetOptionalParams) => Promise<GarnetClusterResource>

listByResourceGroup

List all Garnet clusters in this resource group.

listByResourceGroup: (resourceGroupName: string, options?: GarnetClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<GarnetClusterResource, GarnetClusterResource[], PageSettings>

Property Value

(resourceGroupName: string, options?: GarnetClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<GarnetClusterResource, GarnetClusterResource[], PageSettings>

listBySubscription

List all Garnet clusters in this subscription.

listBySubscription: (options?: GarnetClustersListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<GarnetClusterResource, GarnetClusterResource[], PageSettings>

Property Value

(options?: GarnetClustersListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<GarnetClusterResource, GarnetClusterResource[], PageSettings>

update

Updates some of the properties of a garnet cluster.

update: (resourceGroupName: string, clusterName: string, body: GarnetClusterResourcePatch, options?: GarnetClustersUpdateOptionalParams) => PollerLike<OperationState<GarnetClusterResource>, GarnetClusterResource>

Property Value

(resourceGroupName: string, clusterName: string, body: GarnetClusterResourcePatch, options?: GarnetClustersUpdateOptionalParams) => PollerLike<OperationState<GarnetClusterResource>, GarnetClusterResource>