azure-native.azurestackhci.Cluster
Explore with Pulumi AI
Cluster details. API Version: 2020-10-01.
Example Usage
Create cluster
using System.Collections.Generic;
using System.Linq;
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/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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
args: ClusterArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Cluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
aad_client_id: Optional[str] = None,
aad_tenant_id: Optional[str] = None,
resource_group_name: 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,
tags: Optional[Mapping[str, str]] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var azure_nativeClusterResource = new AzureNative.Azurestackhci.Cluster("azure-nativeClusterResource", new()
{
AadClientId = "string",
AadTenantId = "string",
ResourceGroupName = "string",
ClusterName = "string",
CreatedAt = "string",
CreatedBy = "string",
CreatedByType = "string",
LastModifiedAt = "string",
LastModifiedBy = "string",
LastModifiedByType = "string",
Location = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := azurestackhci.NewCluster(ctx, "azure-nativeClusterResource", &azurestackhci.ClusterArgs{
AadClientId: "string",
AadTenantId: "string",
ResourceGroupName: "string",
ClusterName: "string",
CreatedAt: "string",
CreatedBy: "string",
CreatedByType: "string",
LastModifiedAt: "string",
LastModifiedBy: "string",
LastModifiedByType: "string",
Location: "string",
Tags: map[string]interface{}{
"string": "string",
},
})
var azure_nativeClusterResource = new Cluster("azure-nativeClusterResource", ClusterArgs.builder()
.aadClientId("string")
.aadTenantId("string")
.resourceGroupName("string")
.clusterName("string")
.createdAt("string")
.createdBy("string")
.createdByType("string")
.lastModifiedAt("string")
.lastModifiedBy("string")
.lastModifiedByType("string")
.location("string")
.tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build());
azure_native_cluster_resource = azure_native.azurestackhci.Cluster("azure-nativeClusterResource",
aad_client_id=string,
aad_tenant_id=string,
resource_group_name=string,
cluster_name=string,
created_at=string,
created_by=string,
created_by_type=string,
last_modified_at=string,
last_modified_by=string,
last_modified_by_type=string,
location=string,
tags={
string: string,
})
const azure_nativeClusterResource = new azure_native.azurestackhci.Cluster("azure-nativeClusterResource", {
aadClientId: "string",
aadTenantId: "string",
resourceGroupName: "string",
clusterName: "string",
createdAt: "string",
createdBy: "string",
createdByType: "string",
lastModifiedAt: "string",
lastModifiedBy: "string",
lastModifiedByType: "string",
location: "string",
tags: {
string: "string",
},
});
type: azure-native:azurestackhci:Cluster
properties:
aadClientId: string
aadTenantId: string
clusterName: string
createdAt: string
createdBy: string
createdByType: string
lastModifiedAt: string
lastModifiedBy: string
lastModifiedByType: string
location: string
resourceGroupName: string
tags:
string: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Cluster resource accepts the following input properties:
- Aad
Client stringId - App id of cluster AAD identity.
- Aad
Tenant stringId - Tenant id of cluster AAD identity.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Cluster
Name string - The name of the cluster.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By string | Pulumi.Type Azure Native. Azure Stack HCI. Created By Type - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified string | Pulumi.By Type Azure Native. Azure Stack HCI. Created By Type - The type of identity that last modified the resource.
- Location string
- The geo-location where the resource lives
- Dictionary<string, string>
- Resource tags.
- Aad
Client stringId - App id of cluster AAD identity.
- Aad
Tenant stringId - Tenant id of cluster AAD identity.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Cluster
Name string - The name of the cluster.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By string | CreatedType By Type - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified string | CreatedBy Type By Type - The type of identity that last modified the resource.
- Location string
- The geo-location where the resource lives
- map[string]string
- Resource tags.
- aad
Client StringId - App id of cluster AAD identity.
- aad
Tenant StringId - Tenant id of cluster AAD identity.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- cluster
Name String - The name of the cluster.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By String | CreatedType By Type - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified String | CreatedBy Type By Type - The type of identity that last modified the resource.
- location String
- The geo-location where the resource lives
- Map<String,String>
- Resource tags.
- aad
Client stringId - App id of cluster AAD identity.
- aad
Tenant stringId - Tenant id of cluster AAD identity.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- cluster
Name string - The name of the cluster.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By string | CreatedType By Type - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified string | CreatedBy Type By Type - The type of identity that last modified the resource.
- location string
- The geo-location where the resource lives
- {[key: string]: string}
- Resource tags.
- aad_
client_ strid - App id of cluster AAD identity.
- aad_
tenant_ strid - Tenant id of cluster AAD identity.
- resource_
group_ strname - 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_ str | Createdtype By Type - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ str | Createdby_ type By Type - The type of identity that last modified the resource.
- location str
- The geo-location where the resource lives
- Mapping[str, str]
- Resource tags.
- aad
Client StringId - App id of cluster AAD identity.
- aad
Tenant StringId - Tenant id of cluster AAD identity.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- cluster
Name String - The name of the cluster.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By String | "User" | "Application" | "ManagedType Identity" | "Key" - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified String | "User" | "Application" | "ManagedBy Type Identity" | "Key" - The type of identity that last modified the resource.
- location String
- The geo-location where the resource lives
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:
- Billing
Model string - Type of billing applied to the resource.
- Cloud
Id string - Unique, immutable resource id.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Billing stringTimestamp - Most recent billing meter timestamp.
- Last
Sync stringTimestamp - Most recent cluster sync timestamp.
- Name string
- The name of the resource
- Provisioning
State string - Provisioning state.
- Registration
Timestamp string - First cluster sync timestamp.
- Status string
- Status of the cluster agent.
- Trial
Days doubleRemaining - Number of days remaining in the trial period.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Reported
Properties Pulumi.Azure Native. Azure Stack HCI. Outputs. Cluster Reported Properties Response - Properties reported by cluster agent.
- Billing
Model string - Type of billing applied to the resource.
- Cloud
Id string - Unique, immutable resource id.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Billing stringTimestamp - Most recent billing meter timestamp.
- Last
Sync stringTimestamp - Most recent cluster sync timestamp.
- Name string
- The name of the resource
- Provisioning
State string - Provisioning state.
- Registration
Timestamp string - First cluster sync timestamp.
- Status string
- Status of the cluster agent.
- Trial
Days float64Remaining - Number of days remaining in the trial period.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Reported
Properties ClusterReported Properties Response - Properties reported by cluster agent.
- billing
Model String - Type of billing applied to the resource.
- cloud
Id String - Unique, immutable resource id.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Billing StringTimestamp - Most recent billing meter timestamp.
- last
Sync StringTimestamp - Most recent cluster sync timestamp.
- name String
- The name of the resource
- provisioning
State String - Provisioning state.
- registration
Timestamp String - First cluster sync timestamp.
- status String
- Status of the cluster agent.
- trial
Days DoubleRemaining - Number of days remaining in the trial period.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- reported
Properties ClusterReported Properties Response - Properties reported by cluster agent.
- billing
Model string - Type of billing applied to the resource.
- cloud
Id string - Unique, immutable resource id.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Billing stringTimestamp - Most recent billing meter timestamp.
- last
Sync stringTimestamp - Most recent cluster sync timestamp.
- name string
- The name of the resource
- provisioning
State string - Provisioning state.
- registration
Timestamp string - First cluster sync timestamp.
- status string
- Status of the cluster agent.
- trial
Days numberRemaining - Number of days remaining in the trial period.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- reported
Properties ClusterReported Properties Response - 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_ strtimestamp - Most recent billing meter timestamp.
- last_
sync_ strtimestamp - 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_ floatremaining - 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 ClusterReported Properties Response - Properties reported by cluster agent.
- billing
Model String - Type of billing applied to the resource.
- cloud
Id String - Unique, immutable resource id.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Billing StringTimestamp - Most recent billing meter timestamp.
- last
Sync StringTimestamp - Most recent cluster sync timestamp.
- name String
- The name of the resource
- provisioning
State String - Provisioning state.
- registration
Timestamp String - First cluster sync timestamp.
- status String
- Status of the cluster agent.
- trial
Days NumberRemaining - Number of days remaining in the trial period.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- reported
Properties Property Map - Properties reported by cluster agent.
Supporting Types
ClusterNodeResponse, ClusterNodeResponseArgs
- Core
Count 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.
- Memory
In doubleGi B - 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.
- Os
Name string - Operating system running on the cluster node.
- Os
Version string - Version of the operating system running on the cluster node.
- Serial
Number string - Immutable id of the cluster node.
- Core
Count 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.
- Memory
In float64Gi B - 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.
- Os
Name string - Operating system running on the cluster node.
- Os
Version string - Version of the operating system running on the cluster node.
- Serial
Number string - Immutable id of the cluster node.
- core
Count 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.
- memory
In DoubleGi B - 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.
- os
Name String - Operating system running on the cluster node.
- os
Version String - Version of the operating system running on the cluster node.
- serial
Number String - Immutable id of the cluster node.
- core
Count 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.
- memory
In numberGi B - 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.
- os
Name string - Operating system running on the cluster node.
- os
Version string - Version of the operating system running on the cluster node.
- serial
Number 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_ floatgi_ b - 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.
- core
Count 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.
- memory
In NumberGi B - 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.
- os
Name String - Operating system running on the cluster node.
- os
Version String - Version of the operating system running on the cluster node.
- serial
Number String - Immutable id of the cluster node.
ClusterReportedPropertiesResponse, ClusterReportedPropertiesResponseArgs
- Cluster
Id string - Unique id generated by the on-prem cluster.
- Cluster
Name string - Name of the on-prem cluster connected to this resource.
- Cluster
Version string - Version of the cluster software.
- Last
Updated string - Last time the cluster reported the data.
- Nodes
List<Pulumi.
Azure Native. Azure Stack HCI. Inputs. Cluster Node Response> - List of nodes reported by the cluster.
- Cluster
Id string - Unique id generated by the on-prem cluster.
- Cluster
Name string - Name of the on-prem cluster connected to this resource.
- Cluster
Version string - Version of the cluster software.
- Last
Updated string - Last time the cluster reported the data.
- Nodes
[]Cluster
Node Response - List of nodes reported by the cluster.
- cluster
Id String - Unique id generated by the on-prem cluster.
- cluster
Name String - Name of the on-prem cluster connected to this resource.
- cluster
Version String - Version of the cluster software.
- last
Updated String - Last time the cluster reported the data.
- nodes
List<Cluster
Node Response> - List of nodes reported by the cluster.
- cluster
Id string - Unique id generated by the on-prem cluster.
- cluster
Name string - Name of the on-prem cluster connected to this resource.
- cluster
Version string - Version of the cluster software.
- last
Updated string - Last time the cluster reported the data.
- nodes
Cluster
Node Response[] - 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[Cluster
Node Response] - List of nodes reported by the cluster.
- cluster
Id String - Unique id generated by the on-prem cluster.
- cluster
Name String - Name of the on-prem cluster connected to this resource.
- cluster
Version String - Version of the cluster software.
- last
Updated String - Last time the cluster reported the data.
- nodes List<Property Map>
- List of nodes reported by the cluster.
CreatedByType, CreatedByTypeArgs
- User
- User
- Application
- Application
- Managed
Identity - ManagedIdentity
- Key
- Key
- Created
By Type User - User
- Created
By Type Application - Application
- Created
By Type Managed Identity - ManagedIdentity
- Created
By Type Key - Key
- User
- User
- Application
- Application
- Managed
Identity - ManagedIdentity
- Key
- Key
- User
- User
- Application
- Application
- Managed
Identity - ManagedIdentity
- Key
- Key
- USER
- User
- APPLICATION
- Application
- MANAGED_IDENTITY
- ManagedIdentity
- KEY
- Key
- "User"
- User
- "Application"
- Application
- "Managed
Identity" - 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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v1 pulumi/pulumi-azure-native
- License
- Apache-2.0