azure-native.cosmosdb.getGarnetCluster

Azure Native v3.16.0, Mar 20 26

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

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

Using getGarnetCluster

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGarnetCluster(args: GetGarnetClusterArgs, opts?: InvokeOptions): Promise<GetGarnetClusterResult>
function getGarnetClusterOutput(args: GetGarnetClusterOutputArgs, opts?: InvokeOptions): Output<GetGarnetClusterResult>

def get_garnet_cluster(cluster_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetGarnetClusterResult
def get_garnet_cluster_output(cluster_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetGarnetClusterResult]

func LookupGarnetCluster(ctx *Context, args *LookupGarnetClusterArgs, opts ...InvokeOption) (*LookupGarnetClusterResult, error)
func LookupGarnetClusterOutput(ctx *Context, args *LookupGarnetClusterOutputArgs, opts ...InvokeOption) LookupGarnetClusterResultOutput

> Note: This function is named LookupGarnetCluster in the Go SDK.

public static class GetGarnetCluster 
{
    public static Task<GetGarnetClusterResult> InvokeAsync(GetGarnetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetGarnetClusterResult> Invoke(GetGarnetClusterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGarnetClusterResult> getGarnetCluster(GetGarnetClusterArgs args, InvokeOptions options)
public static Output<GetGarnetClusterResult> getGarnetCluster(GetGarnetClusterArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:cosmosdb:getGarnetCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

ClusterName string: Garnet cache cluster name.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

ClusterName string: Garnet cache cluster name.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

clusterName String: Garnet cache cluster name.
resourceGroupName String: The name of the resource group. The name is case insensitive.

clusterName string: Garnet cache cluster name.
resourceGroupName string: The name of the resource group. The name is case insensitive.

cluster_name str: Garnet cache cluster name.
resource_group_name str: The name of the resource group. The name is case insensitive.

clusterName String: Garnet cache cluster name.
resourceGroupName String: The name of the resource group. The name is case insensitive.

getGarnetCluster Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string: The geo-location where the resource lives
Name string: The name of the resource
Properties Pulumi.AzureNative.CosmosDB.Outputs.GarnetClusterResourceResponseProperties: Properties of a Garnet cache cluster.
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"
Tags Dictionary<string, string>: Resource tags.

AzureApiVersion string: The Azure API version of the resource.
Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string: The geo-location where the resource lives
Name string: The name of the resource
Properties GarnetClusterResourceResponseProperties: Properties of a Garnet cache cluster.
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"
Tags map[string]string: Resource tags.

azureApiVersion String: The Azure API version of the resource.
id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String: The geo-location where the resource lives
name String: The name of the resource
properties GarnetClusterResourceResponseProperties: Properties of a Garnet cache cluster.
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"
tags Map<String,String>: Resource tags.

azureApiVersion string: The Azure API version of the resource.
id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location string: The geo-location where the resource lives
name string: The name of the resource
properties GarnetClusterResourceResponseProperties: Properties of a Garnet cache cluster.
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"
tags {[key: string]: string}: Resource tags.

azure_api_version str: The Azure API version of the resource.
id str: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location str: The geo-location where the resource lives
name str: The name of the resource
properties GarnetClusterResourceResponseProperties: Properties of a Garnet cache cluster.
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"
tags Mapping[str, str]: Resource tags.

azureApiVersion String: The Azure API version of the resource.
id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String: The geo-location where the resource lives
name String: The name of the resource
properties Property Map: Properties of a Garnet cache cluster.
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"
tags Map<String>: Resource tags.

Supporting Types

ErrorAdditionalInfoResponse

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

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.

GarnetClusterResourceResponseEndPoints

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

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

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.