Azure Native v1.102.0, May 2 23

azure-native.azurestackhci.Cluster

Explore with Pulumi AI

Cluster details. API Version: 2020-10-01.

Example Usage

Create cluster

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

return await Deployment.RunAsync(() => 
{
    var cluster = new AzureNative.AzureStackHCI.Cluster("cluster", new()
    {
        AadClientId = "24a6e53d-04e5-44d2-b7cc-1b732a847dfc",
        AadTenantId = "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94",
        ClusterName = "myCluster",
        Location = "East US",
        ResourceGroupName = "test-rg",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := azurestackhci.NewCluster(ctx, "cluster", &azurestackhci.ClusterArgs{
			AadClientId:       pulumi.String("24a6e53d-04e5-44d2-b7cc-1b732a847dfc"),
			AadTenantId:       pulumi.String("7e589cc1-a8b6-4dff-91bd-5ec0fa18db94"),
			ClusterName:       pulumi.String("myCluster"),
			Location:          pulumi.String("East US"),
			ResourceGroupName: pulumi.String("test-rg"),
		})
		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.azurestackhci.Cluster;
import com.pulumi.azurenative.azurestackhci.ClusterArgs;
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 cluster = new Cluster("cluster", ClusterArgs.builder()        
            .aadClientId("24a6e53d-04e5-44d2-b7cc-1b732a847dfc")
            .aadTenantId("7e589cc1-a8b6-4dff-91bd-5ec0fa18db94")
            .clusterName("myCluster")
            .location("East US")
            .resourceGroupName("test-rg")
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

cluster = azure_native.azurestackhci.Cluster("cluster",
    aad_client_id="24a6e53d-04e5-44d2-b7cc-1b732a847dfc",
    aad_tenant_id="7e589cc1-a8b6-4dff-91bd-5ec0fa18db94",
    cluster_name="myCluster",
    location="East US",
    resource_group_name="test-rg")

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

const cluster = new azure_native.azurestackhci.Cluster("cluster", {
    aadClientId: "24a6e53d-04e5-44d2-b7cc-1b732a847dfc",
    aadTenantId: "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94",
    clusterName: "myCluster",
    location: "East US",
    resourceGroupName: "test-rg",
});

resources:
  cluster:
    type: azure-native:azurestackhci:Cluster
    properties:
      aadClientId: 24a6e53d-04e5-44d2-b7cc-1b732a847dfc
      aadTenantId: 7e589cc1-a8b6-4dff-91bd-5ec0fa18db94
      clusterName: myCluster
      location: East US
      resourceGroupName: test-rg

Create Cluster Resource

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            aad_client_id: Optional[str] = None,
            aad_tenant_id: Optional[str] = None,
            cluster_name: Optional[str] = None,
            created_at: Optional[str] = None,
            created_by: Optional[str] = None,
            created_by_type: Optional[Union[str, CreatedByType]] = None,
            last_modified_at: Optional[str] = None,
            last_modified_by: Optional[str] = None,
            last_modified_by_type: Optional[Union[str, CreatedByType]] = None,
            location: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None)
@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)

func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)

public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)

public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

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

name string: The unique name of the resource.
args ClusterArgs: 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 ClusterArgs: 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 ClusterArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Cluster Resource Properties

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

Inputs

The Cluster resource accepts the following input properties:

AadClientId string: App id of cluster AAD identity.
AadTenantId string: Tenant id of cluster AAD identity.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
ClusterName string: The name of the cluster.
CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string | Pulumi.AzureNative.AzureStackHCI.CreatedByType: 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 | Pulumi.AzureNative.AzureStackHCI.CreatedByType: The type of identity that last modified the resource.
Location string: The geo-location where the resource lives
Tags Dictionary<string, string>: Resource tags.

AadClientId string: App id of cluster AAD identity.
AadTenantId string: Tenant id of cluster AAD identity.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
ClusterName string: The name of the cluster.
CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string | CreatedByType: 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 | CreatedByType: The type of identity that last modified the resource.
Location string: The geo-location where the resource lives
Tags map[string]string: Resource tags.

aadClientId String: App id of cluster AAD identity.
aadTenantId String: Tenant id of cluster AAD identity.
resourceGroupName String: The name of the resource group. The name is case insensitive.
clusterName String: The name of the cluster.
createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String | CreatedByType: 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 | CreatedByType: The type of identity that last modified the resource.
location String: The geo-location where the resource lives
tags Map<String,String>: Resource tags.

aadClientId string: App id of cluster AAD identity.
aadTenantId string: Tenant id of cluster AAD identity.
resourceGroupName string: The name of the resource group. The name is case insensitive.
clusterName string: The name of the cluster.
createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string | CreatedByType: 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 | CreatedByType: The type of identity that last modified the resource.
location string: The geo-location where the resource lives
tags {[key: string]: string}: Resource tags.

aad_client_id str: App id of cluster AAD identity.
aad_tenant_id str: Tenant id of cluster AAD identity.
resource_group_name str: The name of the resource group. The name is case insensitive.
cluster_name str: The name of the cluster.
created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str | CreatedByType: 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 | CreatedByType: The type of identity that last modified the resource.
location str: The geo-location where the resource lives
tags Mapping[str, str]: Resource tags.

aadClientId String: App id of cluster AAD identity.
aadTenantId String: Tenant id of cluster AAD identity.
resourceGroupName String: The name of the resource group. The name is case insensitive.
clusterName String: The name of the cluster.
createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String | "User" | "Application" | "ManagedIdentity" | "Key": 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 | "User" | "Application" | "ManagedIdentity" | "Key": The type of identity that last modified the resource.
location String: The geo-location where the resource lives
tags Map<String>: Resource tags.

Outputs

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

BillingModel string: Type of billing applied to the resource.
CloudId string: Unique, immutable resource id.
Id string: The provider-assigned unique ID for this managed resource.
LastBillingTimestamp string: Most recent billing meter timestamp.
LastSyncTimestamp string: Most recent cluster sync timestamp.
Name string: The name of the resource
ProvisioningState string: Provisioning state.
RegistrationTimestamp string: First cluster sync timestamp.
Status string: Status of the cluster agent.
TrialDaysRemaining double: Number of days remaining in the trial period.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ReportedProperties Pulumi.AzureNative.AzureStackHCI.Outputs.ClusterReportedPropertiesResponse: Properties reported by cluster agent.

BillingModel string: Type of billing applied to the resource.
CloudId string: Unique, immutable resource id.
Id string: The provider-assigned unique ID for this managed resource.
LastBillingTimestamp string: Most recent billing meter timestamp.
LastSyncTimestamp string: Most recent cluster sync timestamp.
Name string: The name of the resource
ProvisioningState string: Provisioning state.
RegistrationTimestamp string: First cluster sync timestamp.
Status string: Status of the cluster agent.
TrialDaysRemaining float64: Number of days remaining in the trial period.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ReportedProperties ClusterReportedPropertiesResponse: Properties reported by cluster agent.

billingModel String: Type of billing applied to the resource.
cloudId String: Unique, immutable resource id.
id String: The provider-assigned unique ID for this managed resource.
lastBillingTimestamp String: Most recent billing meter timestamp.
lastSyncTimestamp String: Most recent cluster sync timestamp.
name String: The name of the resource
provisioningState String: Provisioning state.
registrationTimestamp String: First cluster sync timestamp.
status String: Status of the cluster agent.
trialDaysRemaining Double: Number of days remaining in the trial period.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
reportedProperties ClusterReportedPropertiesResponse: Properties reported by cluster agent.

billingModel string: Type of billing applied to the resource.
cloudId string: Unique, immutable resource id.
id string: The provider-assigned unique ID for this managed resource.
lastBillingTimestamp string: Most recent billing meter timestamp.
lastSyncTimestamp string: Most recent cluster sync timestamp.
name string: The name of the resource
provisioningState string: Provisioning state.
registrationTimestamp string: First cluster sync timestamp.
status string: Status of the cluster agent.
trialDaysRemaining number: Number of days remaining in the trial period.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
reportedProperties ClusterReportedPropertiesResponse: Properties reported by cluster agent.

billing_model str: Type of billing applied to the resource.
cloud_id str: Unique, immutable resource id.
id str: The provider-assigned unique ID for this managed resource.
last_billing_timestamp str: Most recent billing meter timestamp.
last_sync_timestamp str: Most recent cluster sync timestamp.
name str: The name of the resource
provisioning_state str: Provisioning state.
registration_timestamp str: First cluster sync timestamp.
status str: Status of the cluster agent.
trial_days_remaining float: Number of days remaining in the trial period.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
reported_properties ClusterReportedPropertiesResponse: Properties reported by cluster agent.

billingModel String: Type of billing applied to the resource.
cloudId String: Unique, immutable resource id.
id String: The provider-assigned unique ID for this managed resource.
lastBillingTimestamp String: Most recent billing meter timestamp.
lastSyncTimestamp String: Most recent cluster sync timestamp.
name String: The name of the resource
provisioningState String: Provisioning state.
registrationTimestamp String: First cluster sync timestamp.
status String: Status of the cluster agent.
trialDaysRemaining Number: Number of days remaining in the trial period.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
reportedProperties Property Map: Properties reported by cluster agent.

Supporting Types

ClusterNodeResponse

CoreCount double: Number of physical cores on the cluster node.
Id double: Id of the node in the cluster.
Manufacturer string: Manufacturer of the cluster node hardware.
MemoryInGiB double: Total available memory on the cluster node (in GiB).
Model string: Model name of the cluster node hardware.
Name string: Name of the cluster node.
OsName string: Operating system running on the cluster node.
OsVersion string: Version of the operating system running on the cluster node.
SerialNumber string: Immutable id of the cluster node.

CoreCount float64: Number of physical cores on the cluster node.
Id float64: Id of the node in the cluster.
Manufacturer string: Manufacturer of the cluster node hardware.
MemoryInGiB float64: Total available memory on the cluster node (in GiB).
Model string: Model name of the cluster node hardware.
Name string: Name of the cluster node.
OsName string: Operating system running on the cluster node.
OsVersion string: Version of the operating system running on the cluster node.
SerialNumber string: Immutable id of the cluster node.

coreCount Double: Number of physical cores on the cluster node.
id Double: Id of the node in the cluster.
manufacturer String: Manufacturer of the cluster node hardware.
memoryInGiB Double: Total available memory on the cluster node (in GiB).
model String: Model name of the cluster node hardware.
name String: Name of the cluster node.
osName String: Operating system running on the cluster node.
osVersion String: Version of the operating system running on the cluster node.
serialNumber String: Immutable id of the cluster node.

coreCount number: Number of physical cores on the cluster node.
id number: Id of the node in the cluster.
manufacturer string: Manufacturer of the cluster node hardware.
memoryInGiB number: Total available memory on the cluster node (in GiB).
model string: Model name of the cluster node hardware.
name string: Name of the cluster node.
osName string: Operating system running on the cluster node.
osVersion string: Version of the operating system running on the cluster node.
serialNumber string: Immutable id of the cluster node.

core_count float: Number of physical cores on the cluster node.
id float: Id of the node in the cluster.
manufacturer str: Manufacturer of the cluster node hardware.
memory_in_gi_b float: Total available memory on the cluster node (in GiB).
model str: Model name of the cluster node hardware.
name str: Name of the cluster node.
os_name str: Operating system running on the cluster node.
os_version str: Version of the operating system running on the cluster node.
serial_number str: Immutable id of the cluster node.

coreCount Number: Number of physical cores on the cluster node.
id Number: Id of the node in the cluster.
manufacturer String: Manufacturer of the cluster node hardware.
memoryInGiB Number: Total available memory on the cluster node (in GiB).
model String: Model name of the cluster node hardware.
name String: Name of the cluster node.
osName String: Operating system running on the cluster node.
osVersion String: Version of the operating system running on the cluster node.
serialNumber String: Immutable id of the cluster node.

ClusterReportedPropertiesResponse

ClusterId string: Unique id generated by the on-prem cluster.
ClusterName string: Name of the on-prem cluster connected to this resource.
ClusterVersion string: Version of the cluster software.
LastUpdated string: Last time the cluster reported the data.
Nodes List<Pulumi.AzureNative.AzureStackHCI.Inputs.ClusterNodeResponse>: List of nodes reported by the cluster.

ClusterId string: Unique id generated by the on-prem cluster.
ClusterName string: Name of the on-prem cluster connected to this resource.
ClusterVersion string: Version of the cluster software.
LastUpdated string: Last time the cluster reported the data.
Nodes []ClusterNodeResponse: List of nodes reported by the cluster.

clusterId String: Unique id generated by the on-prem cluster.
clusterName String: Name of the on-prem cluster connected to this resource.
clusterVersion String: Version of the cluster software.
lastUpdated String: Last time the cluster reported the data.
nodes List<ClusterNodeResponse>: List of nodes reported by the cluster.

clusterId string: Unique id generated by the on-prem cluster.
clusterName string: Name of the on-prem cluster connected to this resource.
clusterVersion string: Version of the cluster software.
lastUpdated string: Last time the cluster reported the data.
nodes ClusterNodeResponse[]: List of nodes reported by the cluster.

cluster_id str: Unique id generated by the on-prem cluster.
cluster_name str: Name of the on-prem cluster connected to this resource.
cluster_version str: Version of the cluster software.
last_updated str: Last time the cluster reported the data.
nodes Sequence[ClusterNodeResponse]: List of nodes reported by the cluster.

clusterId String: Unique id generated by the on-prem cluster.
clusterName String: Name of the on-prem cluster connected to this resource.
clusterVersion String: Version of the cluster software.
lastUpdated String: Last time the cluster reported the data.
nodes List<Property Map>: List of nodes reported by the cluster.

CreatedByType

User: User
Application: Application
ManagedIdentity: ManagedIdentity
Key: Key

CreatedByTypeUser: User
CreatedByTypeApplication: Application
CreatedByTypeManagedIdentity: ManagedIdentity
CreatedByTypeKey: Key

User: User
Application: Application
ManagedIdentity: ManagedIdentity
Key: Key

User: User
Application: Application
ManagedIdentity: ManagedIdentity
Key: Key

USER: User
APPLICATION: Application
MANAGED_IDENTITY: ManagedIdentity
KEY: Key

"User": User
"Application": Application
"ManagedIdentity": ManagedIdentity
"Key": Key

Import

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

$ pulumi import azure-native:azurestackhci:Cluster myCluster /subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0