1. Packages
  2. Azure Native
  3. API Docs
  4. cosmosdb
  5. GarnetCluster
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.cosmosdb.GarnetCluster

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    Representation of a Garnet cache cluster.

    Uses Azure REST API version 2025-11-01-preview.

    Example Usage

    CosmosDBGarnetClusterCreate

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var garnetCluster = new AzureNative.CosmosDB.GarnetCluster("garnetCluster", new()
    {
        ClusterName = "garnet-prod",
        Location = "West US",
        Properties = new AzureNative.CosmosDB.Inputs.GarnetClusterResourcePropertiesArgs
        {
            NodeCount = 4,
            NodeSku = "Standard_DS13_v2",
            ReplicationFactor = 2,
            SubnetId = "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management",
        },
        ResourceGroupName = "garnet-prod-rg",
        Tags = null,
    });

});

    package main

import (
	cosmosdb "github.com/pulumi/pulumi-azure-native-sdk/cosmosdb/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cosmosdb.NewGarnetCluster(ctx, "garnetCluster", &cosmosdb.GarnetClusterArgs{
			ClusterName: pulumi.String("garnet-prod"),
			Location:    pulumi.String("West US"),
			Properties: &cosmosdb.GarnetClusterResourcePropertiesArgs{
				NodeCount:         pulumi.Int(4),
				NodeSku:           pulumi.String("Standard_DS13_v2"),
				ReplicationFactor: pulumi.Int(2),
				SubnetId:          pulumi.String("/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management"),
			},
			ResourceGroupName: pulumi.String("garnet-prod-rg"),
			Tags:              pulumi.StringMap{},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.cosmosdb.GarnetCluster;
import com.pulumi.azurenative.cosmosdb.GarnetClusterArgs;
import com.pulumi.azurenative.cosmosdb.inputs.GarnetClusterResourcePropertiesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var garnetCluster = new GarnetCluster("garnetCluster", GarnetClusterArgs.builder()
            .clusterName("garnet-prod")
            .location("West US")
            .properties(GarnetClusterResourcePropertiesArgs.builder()
                .nodeCount(4)
                .nodeSku("Standard_DS13_v2")
                .replicationFactor(2)
                .subnetId("/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management")
                .build())
            .resourceGroupName("garnet-prod-rg")
            .tags(Map.ofEntries(
            ))
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const garnetCluster = new azure_native.cosmosdb.GarnetCluster("garnetCluster", {
    clusterName: "garnet-prod",
    location: "West US",
    properties: {
        nodeCount: 4,
        nodeSku: "Standard_DS13_v2",
        replicationFactor: 2,
        subnetId: "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management",
    },
    resourceGroupName: "garnet-prod-rg",
    tags: {},
});

    import pulumi
import pulumi_azure_native as azure_native

garnet_cluster = azure_native.cosmosdb.GarnetCluster("garnetCluster",
    cluster_name="garnet-prod",
    location="West US",
    properties={
        "node_count": 4,
        "node_sku": "Standard_DS13_v2",
        "replication_factor": 2,
        "subnet_id": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management",
    },
    resource_group_name="garnet-prod-rg",
    tags={})

    resources:
  garnetCluster:
    type: azure-native:cosmosdb:GarnetCluster
    properties:
      clusterName: garnet-prod
      location: West US
      properties:
        nodeCount: 4
        nodeSku: Standard_DS13_v2
        replicationFactor: 2
        subnetId: /subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management
      resourceGroupName: garnet-prod-rg
      tags: {}

    Create GarnetCluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GarnetCluster(name: string, args: GarnetClusterArgs, opts?: CustomResourceOptions);
    @overload
def GarnetCluster(resource_name: str,
                  args: GarnetClusterArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def GarnetCluster(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  resource_group_name: Optional[str] = None,
                  cluster_name: Optional[str] = None,
                  location: Optional[str] = None,
                  properties: Optional[GarnetClusterResourcePropertiesArgs] = None,
                  tags: Optional[Mapping[str, str]] = None)
    func NewGarnetCluster(ctx *Context, name string, args GarnetClusterArgs, opts ...ResourceOption) (*GarnetCluster, error)
    public GarnetCluster(string name, GarnetClusterArgs args, CustomResourceOptions? opts = null)
    public GarnetCluster(String name, GarnetClusterArgs args)
public GarnetCluster(String name, GarnetClusterArgs args, CustomResourceOptions options)

    type: azure-native:cosmosdb:GarnetCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GarnetClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GarnetClusterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GarnetClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GarnetClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GarnetClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var garnetClusterResource = new AzureNative.CosmosDB.GarnetCluster("garnetClusterResource", new()
{
    ResourceGroupName = "string",
    ClusterName = "string",
    Location = "string",
    Properties = new AzureNative.CosmosDB.Inputs.GarnetClusterResourcePropertiesArgs
    {
        AllocationState = "string",
        AvailabilityZone = false,
        ClusterType = "string",
        Extensions = new[]
        {
            "string",
        },
        NodeCount = 0,
        NodeSku = "string",
        ReplicationFactor = 0,
        SubnetId = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := cosmosdb.NewGarnetCluster(ctx, "garnetClusterResource", &cosmosdb.GarnetClusterArgs{
	ResourceGroupName: pulumi.String("string"),
	ClusterName:       pulumi.String("string"),
	Location:          pulumi.String("string"),
	Properties: &cosmosdb.GarnetClusterResourcePropertiesArgs{
		AllocationState:  pulumi.String("string"),
		AvailabilityZone: pulumi.Bool(false),
		ClusterType:      pulumi.String("string"),
		Extensions: pulumi.StringArray{
			pulumi.String("string"),
		},
		NodeCount:         pulumi.Int(0),
		NodeSku:           pulumi.String("string"),
		ReplicationFactor: pulumi.Int(0),
		SubnetId:          pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var garnetClusterResource = new GarnetCluster("garnetClusterResource", GarnetClusterArgs.builder()
    .resourceGroupName("string")
    .clusterName("string")
    .location("string")
    .properties(GarnetClusterResourcePropertiesArgs.builder()
        .allocationState("string")
        .availabilityZone(false)
        .clusterType("string")
        .extensions("string")
        .nodeCount(0)
        .nodeSku("string")
        .replicationFactor(0)
        .subnetId("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());

    garnet_cluster_resource = azure_native.cosmosdb.GarnetCluster("garnetClusterResource",
    resource_group_name="string",
    cluster_name="string",
    location="string",
    properties={
        "allocation_state": "string",
        "availability_zone": False,
        "cluster_type": "string",
        "extensions": ["string"],
        "node_count": 0,
        "node_sku": "string",
        "replication_factor": 0,
        "subnet_id": "string",
    },
    tags={
        "string": "string",
    })

    const garnetClusterResource = new azure_native.cosmosdb.GarnetCluster("garnetClusterResource", {
    resourceGroupName: "string",
    clusterName: "string",
    location: "string",
    properties: {
        allocationState: "string",
        availabilityZone: false,
        clusterType: "string",
        extensions: ["string"],
        nodeCount: 0,
        nodeSku: "string",
        replicationFactor: 0,
        subnetId: "string",
    },
    tags: {
        string: "string",
    },
});

    type: azure-native:cosmosdb:GarnetCluster
properties:
    clusterName: string
    location: string
    properties:
        allocationState: string
        availabilityZone: false
        clusterType: string
        extensions:
            - string
        nodeCount: 0
        nodeSku: string
        replicationFactor: 0
        subnetId: string
    resourceGroupName: string
    tags:
        string: string

    GarnetCluster Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The GarnetCluster resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ClusterName string
    Garnet cache cluster name.
    Location string
    The geo-location where the resource lives
    Properties Pulumi.AzureNative.CosmosDB.Inputs.GarnetClusterResourceProperties
    Properties of a Garnet cache cluster.
    Tags Dictionary<string, string>
    Resource tags.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ClusterName string
    Garnet cache cluster name.
    Location string
    The geo-location where the resource lives
    Properties GarnetClusterResourcePropertiesArgs
    Properties of a Garnet cache cluster.
    Tags map[string]string
    Resource tags.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    clusterName String
    Garnet cache cluster name.
    location String
    The geo-location where the resource lives
    properties GarnetClusterResourceProperties
    Properties of a Garnet cache cluster.
    tags Map<String,String>
    Resource tags.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    clusterName string
    Garnet cache cluster name.
    location string
    The geo-location where the resource lives
    properties GarnetClusterResourceProperties
    Properties of a Garnet cache cluster.
    tags {[key: string]: string}
    Resource tags.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    cluster_name str
    Garnet cache cluster name.
    location str
    The geo-location where the resource lives
    properties GarnetClusterResourcePropertiesArgs
    Properties of a Garnet cache cluster.
    tags Mapping[str, str]
    Resource tags.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    clusterName String
    Garnet cache cluster name.
    location String
    The geo-location where the resource lives
    properties Property Map
    Properties of a Garnet cache cluster.
    tags Map<String>
    Resource tags.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GarnetCluster resource produces the following output properties:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.CosmosDB.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azure_api_version str
    The Azure API version of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    AllocationState, AllocationStateArgs

    Active
    Active
    Deallocated
    Deallocated
    AllocationStateActive
    Active
    AllocationStateDeallocated
    Deallocated
    Active
    Active
    Deallocated
    Deallocated
    Active
    Active
    Deallocated
    Deallocated
    ACTIVE
    Active
    DEALLOCATED
    Deallocated
    "Active"
    Active
    "Deallocated"
    Deallocated

    ClusterType, ClusterTypeArgs

    Production
    Production
    NonProduction
    NonProduction
    ClusterTypeProduction
    Production
    ClusterTypeNonProduction
    NonProduction
    Production
    Production
    NonProduction
    NonProduction
    Production
    Production
    NonProduction
    NonProduction
    PRODUCTION
    Production
    NON_PRODUCTION
    NonProduction
    "Production"
    Production
    "NonProduction"
    NonProduction

    ErrorAdditionalInfoResponse, ErrorAdditionalInfoResponseArgs

    The resource management error additional info.
    Info object
    The additional info.
    Type string
    The additional info type.
    Info interface{}
    The additional info.
    Type string
    The additional info type.
    info Object
    The additional info.
    type String
    The additional info type.
    info any
    The additional info.
    type string
    The additional info type.
    info Any
    The additional info.
    type str
    The additional info type.
    info Any
    The additional info.
    type String
    The additional info type.

    ErrorDetailResponse, ErrorDetailResponseArgs

    The error detail.
    AdditionalInfo List<Pulumi.AzureNative.CosmosDB.Inputs.ErrorAdditionalInfoResponse>
    The error additional info.
    Code string
    The error code.
    Details List<Pulumi.AzureNative.CosmosDB.Inputs.ErrorDetailResponse>
    The error details.
    Message string
    The error message.
    Target string
    The error target.
    AdditionalInfo []ErrorAdditionalInfoResponse
    The error additional info.
    Code string
    The error code.
    Details []ErrorDetailResponse
    The error details.
    Message string
    The error message.
    Target string
    The error target.
    additionalInfo List<ErrorAdditionalInfoResponse>
    The error additional info.
    code String
    The error code.
    details List<ErrorDetailResponse>
    The error details.
    message String
    The error message.
    target String
    The error target.
    additionalInfo ErrorAdditionalInfoResponse[]
    The error additional info.
    code string
    The error code.
    details ErrorDetailResponse[]
    The error details.
    message string
    The error message.
    target string
    The error target.
    additional_info Sequence[ErrorAdditionalInfoResponse]
    The error additional info.
    code str
    The error code.
    details Sequence[ErrorDetailResponse]
    The error details.
    message str
    The error message.
    target str
    The error target.
    additionalInfo List<Property Map>
    The error additional info.
    code String
    The error code.
    details List<Property Map>
    The error details.
    message String
    The error message.
    target String
    The error target.

    GarnetClusterResourceProperties, GarnetClusterResourcePropertiesArgs

    Properties of a Garnet cache cluster.
    AllocationState string | Pulumi.AzureNative.CosmosDB.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 bool
    If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the garnet cluster virtual machines.
    ClusterType string | Pulumi.AzureNative.CosmosDB.ClusterType
    Type of the cluster. If set to Production, some operations might not be permitted on cluster.
    Extensions List<string>
    Extensions to be added or updated on cluster.
    NodeCount int
    Number of nodes
    NodeSku string
    Virtual Machine SKU used for clusters. Default value is Standard_DS14_v2
    ReplicationFactor int
    Number of copies of data maintained by the cluster
    SubnetId string
    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//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
    AllocationState string | 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 bool
    If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the garnet cluster virtual machines.
    ClusterType string | ClusterType
    Type of the cluster. If set to Production, some operations might not be permitted on cluster.
    Extensions []string
    Extensions to be added or updated on cluster.
    NodeCount int
    Number of nodes
    NodeSku string
    Virtual Machine SKU used for clusters. Default value is Standard_DS14_v2
    ReplicationFactor int
    Number of copies of data maintained by the cluster
    SubnetId string
    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//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
    allocationState String | 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 Boolean
    If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the garnet cluster virtual machines.
    clusterType String | ClusterType
    Type of the cluster. If set to Production, some operations might not be permitted on cluster.
    extensions List<String>
    Extensions to be added or updated on cluster.
    nodeCount Integer
    Number of nodes
    nodeSku String
    Virtual Machine SKU used for clusters. Default value is Standard_DS14_v2
    replicationFactor Integer
    Number of copies of data maintained by the cluster
    subnetId String
    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//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
    allocationState string | 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 boolean
    If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the garnet cluster virtual machines.
    clusterType string | ClusterType
    Type of the cluster. If set to Production, some operations might not be permitted on cluster.
    extensions string[]
    Extensions to be added or updated on cluster.
    nodeCount number
    Number of nodes
    nodeSku string
    Virtual Machine SKU used for clusters. Default value is Standard_DS14_v2
    replicationFactor number
    Number of copies of data maintained by the cluster
    subnetId string
    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//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
    allocation_state str | 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.
    availability_zone bool
    If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the garnet cluster virtual machines.
    cluster_type str | ClusterType
    Type of the cluster. If set to Production, some operations might not be permitted on cluster.
    extensions Sequence[str]
    Extensions to be added or updated on cluster.
    node_count int
    Number of nodes
    node_sku str
    Virtual Machine SKU used for clusters. Default value is Standard_DS14_v2
    replication_factor int
    Number of copies of data maintained by the cluster
    subnet_id str
    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//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
    allocationState String | "Active" | "Deallocated"
    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 Boolean
    If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the garnet cluster virtual machines.
    clusterType String | "Production" | "NonProduction"
    Type of the cluster. If set to Production, some operations might not be permitted on cluster.
    extensions List<String>
    Extensions to be added or updated on cluster.
    nodeCount Number
    Number of nodes
    nodeSku String
    Virtual Machine SKU used for clusters. Default value is Standard_DS14_v2
    replicationFactor Number
    Number of copies of data maintained by the cluster
    subnetId String
    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//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'

    GarnetClusterResourceResponseEndPoints, GarnetClusterResourceResponseEndPointsArgs

    IpAddress string
    Ipv4 address of the endpoint
    Port int
    Port number
    IpAddress string
    Ipv4 address of the endpoint
    Port int
    Port number
    ipAddress String
    Ipv4 address of the endpoint
    port Integer
    Port number
    ipAddress string
    Ipv4 address of the endpoint
    port number
    Port number
    ip_address str
    Ipv4 address of the endpoint
    port int
    Port number
    ipAddress String
    Ipv4 address of the endpoint
    port Number
    Port number

    GarnetClusterResourceResponseProperties, GarnetClusterResourceResponsePropertiesArgs

    Properties of a Garnet cache cluster.
    EndPoints List<Pulumi.AzureNative.CosmosDB.Inputs.GarnetClusterResourceResponseEndPoints>
    endpoints for clients to connect to the cluster.
    ProvisioningState string
    The status of the resource at the time the operation was called.
    AllocationState string
    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 bool
    If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the garnet cluster virtual machines.
    ClusterType string
    Type of the cluster. If set to Production, some operations might not be permitted on cluster.
    Extensions List<string>
    Extensions to be added or updated on cluster.
    NodeCount int
    Number of nodes
    NodeSku string
    Virtual Machine SKU used for clusters. Default value is Standard_DS14_v2
    ProvisionError Pulumi.AzureNative.CosmosDB.Inputs.ErrorDetailResponse
    Error related to resource provisioning.
    ReplicationFactor int
    Number of copies of data maintained by the cluster
    SubnetId string
    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//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
    EndPoints []GarnetClusterResourceResponseEndPoints
    endpoints for clients to connect to the cluster.
    ProvisioningState string
    The status of the resource at the time the operation was called.
    AllocationState string
    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 bool
    If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the garnet cluster virtual machines.
    ClusterType string
    Type of the cluster. If set to Production, some operations might not be permitted on cluster.
    Extensions []string
    Extensions to be added or updated on cluster.
    NodeCount int
    Number of nodes
    NodeSku string
    Virtual Machine SKU used for clusters. Default value is Standard_DS14_v2
    ProvisionError ErrorDetailResponse
    Error related to resource provisioning.
    ReplicationFactor int
    Number of copies of data maintained by the cluster
    SubnetId string
    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//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
    endPoints List<GarnetClusterResourceResponseEndPoints>
    endpoints for clients to connect to the cluster.
    provisioningState String
    The status of the resource at the time the operation was called.
    allocationState String
    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 Boolean
    If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the garnet cluster virtual machines.
    clusterType String
    Type of the cluster. If set to Production, some operations might not be permitted on cluster.
    extensions List<String>
    Extensions to be added or updated on cluster.
    nodeCount Integer
    Number of nodes
    nodeSku String
    Virtual Machine SKU used for clusters. Default value is Standard_DS14_v2
    provisionError ErrorDetailResponse
    Error related to resource provisioning.
    replicationFactor Integer
    Number of copies of data maintained by the cluster
    subnetId String
    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//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
    endPoints GarnetClusterResourceResponseEndPoints[]
    endpoints for clients to connect to the cluster.
    provisioningState string
    The status of the resource at the time the operation was called.
    allocationState string
    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 boolean
    If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the garnet cluster virtual machines.
    clusterType string
    Type of the cluster. If set to Production, some operations might not be permitted on cluster.
    extensions string[]
    Extensions to be added or updated on cluster.
    nodeCount number
    Number of nodes
    nodeSku string
    Virtual Machine SKU used for clusters. Default value is Standard_DS14_v2
    provisionError ErrorDetailResponse
    Error related to resource provisioning.
    replicationFactor number
    Number of copies of data maintained by the cluster
    subnetId string
    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//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
    end_points Sequence[GarnetClusterResourceResponseEndPoints]
    endpoints for clients to connect to the cluster.
    provisioning_state str
    The status of the resource at the time the operation was called.
    allocation_state str
    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.
    availability_zone bool
    If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the garnet cluster virtual machines.
    cluster_type str
    Type of the cluster. If set to Production, some operations might not be permitted on cluster.
    extensions Sequence[str]
    Extensions to be added or updated on cluster.
    node_count int
    Number of nodes
    node_sku str
    Virtual Machine SKU used for clusters. Default value is Standard_DS14_v2
    provision_error ErrorDetailResponse
    Error related to resource provisioning.
    replication_factor int
    Number of copies of data maintained by the cluster
    subnet_id str
    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//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
    endPoints List<Property Map>
    endpoints for clients to connect to the cluster.
    provisioningState String
    The status of the resource at the time the operation was called.
    allocationState String
    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 Boolean
    If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the garnet cluster virtual machines.
    clusterType String
    Type of the cluster. If set to Production, some operations might not be permitted on cluster.
    extensions List<String>
    Extensions to be added or updated on cluster.
    nodeCount Number
    Number of nodes
    nodeSku String
    Virtual Machine SKU used for clusters. Default value is Standard_DS14_v2
    provisionError Property Map
    Error related to resource provisioning.
    replicationFactor Number
    Number of copies of data maintained by the cluster
    subnetId String
    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//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'

    SystemDataResponse, SystemDataResponseArgs

    Metadata pertaining to creation and last modification of the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:cosmosdb:GarnetCluster garnet-prod /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/garnetClusters/{clusterName}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.16.0
    published on Friday, Mar 20, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native
      Try Pulumi Cloud free. Your team will thank you.