Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Azure Native
  4. API Docs
  5. cosmosdb
  6. getGarnetCluster
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.25.0
published on Wednesday, Aug 5, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.cosmosdb.getGarnetCluster

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.25.0
published on Wednesday, Aug 5, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    Get the properties of a Garnet cache cluster.

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

    Other available API versions: 2026-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cosmosdb [ApiVersion]. See the version guide for details.

    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: pulumi.Input[Optional[str]] = None,
                       resource_group_name: pulumi.Input[Optional[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
    data "azure-native_cosmosdb_get_garnet_cluster" "name" {
    # arguments
}

    The following arguments are supported:

    ClusterName string
    The name of the GarnetClusterResource
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ClusterName string
    The name of the GarnetClusterResource
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    cluster_name string
    The name of the GarnetClusterResource
    resource_group_name string
    The name of the resource group. The name is case insensitive.
    clusterName String
    The name of the GarnetClusterResource
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    clusterName string
    The name of the GarnetClusterResource
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    cluster_name str
    The name of the GarnetClusterResource
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    clusterName String
    The name of the GarnetClusterResource
    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.GarnetClusterResourcePropertiesResponse
    The resource-specific properties for this 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"
    Identity Pulumi.AzureNative.CosmosDB.Outputs.ManagedCassandraManagedServiceIdentityResponse
    Identity for the resource.
    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 GarnetClusterResourcePropertiesResponse
    The resource-specific properties for this 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"
    Identity ManagedCassandraManagedServiceIdentityResponse
    Identity for the resource.
    Tags map[string]string
    Resource tags.
    azure_api_version 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 object
    The resource-specific properties for this resource.
    system_data object
    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"
    identity object
    Identity for the resource.
    tags map(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 GarnetClusterResourcePropertiesResponse
    The resource-specific properties for this 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"
    identity ManagedCassandraManagedServiceIdentityResponse
    Identity for the resource.
    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 GarnetClusterResourcePropertiesResponse
    The resource-specific properties for this 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"
    identity ManagedCassandraManagedServiceIdentityResponse
    Identity for the resource.
    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 GarnetClusterResourcePropertiesResponse
    The resource-specific properties for this 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"
    identity ManagedCassandraManagedServiceIdentityResponse
    Identity for the resource.
    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
    The resource-specific properties for this 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"
    identity Property Map
    Identity for the resource.
    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 any
    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.
    additional_info list(object)
    The error additional info.
    code string
    The error code.
    details list(object)
    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.

    GarnetClusterResourcePropertiesEndPointsItemResponse

    IpAddress string
    Ipv4 address of the endpoint.
    Port int
    Port number.
    IpAddress string
    Ipv4 address of the endpoint.
    Port int
    Port number.
    ip_address string
    Ipv4 address of the endpoint.
    port number
    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.

    GarnetClusterResourcePropertiesResponse

    EndPoints List<Pulumi.AzureNative.CosmosDB.Inputs.GarnetClusterResourcePropertiesEndPointsItemResponse>
    Endpoints for clients to connect to the cluster.
    ProvisioningState string
    The provisioning state of the resource.
    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 []GarnetClusterResourcePropertiesEndPointsItemResponse
    Endpoints for clients to connect to the cluster.
    ProvisioningState string
    The provisioning state of the resource.
    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/'
    end_points list(object)
    Endpoints for clients to connect to the cluster.
    provisioning_state string
    The provisioning state of the resource.
    allocation_state 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.
    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 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.
    node_count number
    Number of nodes.
    node_sku string
    Virtual Machine SKU used for clusters. Default value is Standard_DS14_v2.
    provision_error object
    Error related to resource provisioning.
    replication_factor number
    Number of copies of data maintained by the cluster.
    subnet_id 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<GarnetClusterResourcePropertiesEndPointsItemResponse>
    Endpoints for clients to connect to the cluster.
    provisioningState String
    The provisioning state of the resource.
    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 GarnetClusterResourcePropertiesEndPointsItemResponse[]
    Endpoints for clients to connect to the cluster.
    provisioningState string
    The provisioning state of the resource.
    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[GarnetClusterResourcePropertiesEndPointsItemResponse]
    Endpoints for clients to connect to the cluster.
    provisioning_state str
    The provisioning state of the resource.
    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 provisioning state of the resource.
    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/'

    ManagedCassandraManagedServiceIdentityResponse

    PrincipalId string
    The object id of the identity resource.
    TenantId string
    The tenant id of the resource.
    Type string
    The type of the resource.
    PrincipalId string
    The object id of the identity resource.
    TenantId string
    The tenant id of the resource.
    Type string
    The type of the resource.
    principal_id string
    The object id of the identity resource.
    tenant_id string
    The tenant id of the resource.
    type string
    The type of the resource.
    principalId String
    The object id of the identity resource.
    tenantId String
    The tenant id of the resource.
    type String
    The type of the resource.
    principalId string
    The object id of the identity resource.
    tenantId string
    The tenant id of the resource.
    type string
    The type of the resource.
    principal_id str
    The object id of the identity resource.
    tenant_id str
    The tenant id of the resource.
    type str
    The type of the resource.
    principalId String
    The object id of the identity resource.
    tenantId String
    The tenant id of the resource.
    type String
    The type of the resource.

    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.
    created_at string
    The timestamp of resource creation (UTC).
    created_by string
    The identity that created the resource.
    created_by_type string
    The type of identity that created the resource.
    last_modified_at string
    The timestamp of resource last modification (UTC)
    last_modified_by string
    The identity that last modified the resource.
    last_modified_by_type 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.

    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.25.0
    published on Wednesday, Aug 5, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial