GarnetClusterResourceProperties interface

Package:

@azure/arm-cosmosdb

Properties of a Garnet cache cluster.

Properties

allocationState	Allocation state of the cluster and data center resources. Active implies the virtual machines of the cluster are allocated, deallocated implies virtual machines and resources are deallocated.
availabilityZone	If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the garnet cluster virtual machines.
clusterType	Type of the cluster. If set to Production, some operations might not be permitted on cluster.
endPoints	Endpoints for clients to connect to the cluster.
extensions	Extensions to be added or updated on cluster.
nodeCount	Number of nodes.
nodeSku	Virtual Machine SKU used for clusters. Default value is Standard_DS14_v2.
provisionError	Error related to resource provisioning.
provisioningState	The provisioning state of the resource.
replicationFactor	Number of copies of data maintained by the cluster.
subnetId	Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions/<subscription id>/resourceGroups/<resource group>/providers/Microsoft.Network/virtualNetworks/<virtual network>/subnets/<subnet>'

Property Details

allocationState

Allocation state of the cluster and data center resources. Active implies the virtual machines of the cluster are allocated, deallocated implies virtual machines and resources are deallocated.

allocationState?: string

Property Value

string

availabilityZone

If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the garnet cluster virtual machines.

availabilityZone?: boolean

Property Value

boolean

clusterType

Type of the cluster. If set to Production, some operations might not be permitted on cluster.

clusterType?: string

Property Value

string

endPoints

Endpoints for clients to connect to the cluster.

endPoints?: GarnetClusterResourcePropertiesEndPointsItem[]

Property Value

GarnetClusterResourcePropertiesEndPointsItem[]

extensions

Extensions to be added or updated on cluster.

extensions?: string[]

Property Value

string[]

nodeCount

Number of nodes.

nodeCount?: number

Property Value

number

nodeSku

Virtual Machine SKU used for clusters. Default value is Standard_DS14_v2.

nodeSku?: string

Property Value

string

provisionError

Error related to resource provisioning.

provisionError?: ErrorDetail

Property Value

ErrorDetail

provisioningState

The provisioning state of the resource.

provisioningState?: string

Property Value

string

replicationFactor

Number of copies of data maintained by the cluster.

replicationFactor?: number

Property Value

number

subnetId

Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions/<subscription id>/resourceGroups/<resource group>/providers/Microsoft.Network/virtualNetworks/<virtual network>/subnets/<subnet>'

subnetId?: string

Property Value

string