Documentation
¶
Index ¶
- type HciCluster
- type HciClusterArgs
- type HciClusterArray
- type HciClusterArrayInput
- type HciClusterArrayOutput
- func (HciClusterArrayOutput) ElementType() reflect.Type
- func (o HciClusterArrayOutput) Index(i pulumi.IntInput) HciClusterOutput
- func (o HciClusterArrayOutput) ToHciClusterArrayOutput() HciClusterArrayOutput
- func (o HciClusterArrayOutput) ToHciClusterArrayOutputWithContext(ctx context.Context) HciClusterArrayOutput
- type HciClusterInput
- type HciClusterMap
- type HciClusterMapInput
- type HciClusterMapOutput
- func (HciClusterMapOutput) ElementType() reflect.Type
- func (o HciClusterMapOutput) MapIndex(k pulumi.StringInput) HciClusterOutput
- func (o HciClusterMapOutput) ToHciClusterMapOutput() HciClusterMapOutput
- func (o HciClusterMapOutput) ToHciClusterMapOutputWithContext(ctx context.Context) HciClusterMapOutput
- type HciClusterOutput
- func (o HciClusterOutput) AutomanageConfigurationId() pulumi.StringPtrOutput
- func (o HciClusterOutput) ClientId() pulumi.StringOutput
- func (HciClusterOutput) ElementType() reflect.Type
- func (o HciClusterOutput) Location() pulumi.StringOutput
- func (o HciClusterOutput) Name() pulumi.StringOutput
- func (o HciClusterOutput) ResourceGroupName() pulumi.StringOutput
- func (o HciClusterOutput) Tags() pulumi.StringMapOutput
- func (o HciClusterOutput) TenantId() pulumi.StringOutput
- func (o HciClusterOutput) ToHciClusterOutput() HciClusterOutput
- func (o HciClusterOutput) ToHciClusterOutputWithContext(ctx context.Context) HciClusterOutput
- type HciClusterState
- type LookupHciClusterArgs
- type LookupHciClusterOutputArgs
- type LookupHciClusterResult
- type LookupHciClusterResultOutput
- func (o LookupHciClusterResultOutput) AutomanageConfigurationId() pulumi.StringOutput
- func (o LookupHciClusterResultOutput) ClientId() pulumi.StringOutput
- func (LookupHciClusterResultOutput) ElementType() reflect.Type
- func (o LookupHciClusterResultOutput) Id() pulumi.StringOutput
- func (o LookupHciClusterResultOutput) Location() pulumi.StringOutput
- func (o LookupHciClusterResultOutput) Name() pulumi.StringOutput
- func (o LookupHciClusterResultOutput) ResourceGroupName() pulumi.StringOutput
- func (o LookupHciClusterResultOutput) Tags() pulumi.StringMapOutput
- func (o LookupHciClusterResultOutput) TenantId() pulumi.StringOutput
- func (o LookupHciClusterResultOutput) ToLookupHciClusterResultOutput() LookupHciClusterResultOutput
- func (o LookupHciClusterResultOutput) ToLookupHciClusterResultOutputWithContext(ctx context.Context) LookupHciClusterResultOutput
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type HciCluster ¶
type HciCluster struct { pulumi.CustomResourceState // The ID of the Automanage Configuration assigned to the Azure Stack HCI Cluster. AutomanageConfigurationId pulumi.StringPtrOutput `pulumi:"automanageConfigurationId"` // The Client ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created. ClientId pulumi.StringOutput `pulumi:"clientId"` // The Azure Region where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created. Location pulumi.StringOutput `pulumi:"location"` // The name which should be used for this Azure Stack HCI Cluster. Changing this forces a new resource to be created. Name pulumi.StringOutput `pulumi:"name"` // The name of the Resource Group where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"` // A mapping of tags which should be assigned to the Azure Stack HCI Cluster. Tags pulumi.StringMapOutput `pulumi:"tags"` // The Tenant ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created. // // > **NOTE** If unspecified the Tenant ID of the Provider will be used. TenantId pulumi.StringOutput `pulumi:"tenantId"` }
Manages an Azure Stack HCI Cluster.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core" "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/stack" "github.com/pulumi/pulumi-azuread/sdk/v5/go/azuread" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleApplication, err := azuread.LookupApplication(ctx, &azuread.LookupApplicationArgs{ DisplayName: pulumi.StringRef("Allowed resource types"), }, nil) if err != nil { return err } current, err := core.GetClientConfig(ctx, nil, nil) if err != nil { return err } exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{ Location: pulumi.String("West Europe"), }) if err != nil { return err } _, err = stack.NewHciCluster(ctx, "exampleHciCluster", &stack.HciClusterArgs{ ResourceGroupName: exampleResourceGroup.Name, Location: exampleResourceGroup.Location, ClientId: *pulumi.String(exampleApplication.ApplicationId), TenantId: *pulumi.String(current.TenantId), }) if err != nil { return err } return nil }) }
```
## Import
Azure Stack HCI Clusters can be imported using the `resource id`, e.g.
```sh
$ pulumi import azure:stack/hciCluster:HciCluster example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AzureStackHCI/clusters/cluster1
```
func GetHciCluster ¶
func GetHciCluster(ctx *pulumi.Context, name string, id pulumi.IDInput, state *HciClusterState, opts ...pulumi.ResourceOption) (*HciCluster, error)
GetHciCluster gets an existing HciCluster resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewHciCluster ¶
func NewHciCluster(ctx *pulumi.Context, name string, args *HciClusterArgs, opts ...pulumi.ResourceOption) (*HciCluster, error)
NewHciCluster registers a new resource with the given unique name, arguments, and options.
func (*HciCluster) ElementType ¶
func (*HciCluster) ElementType() reflect.Type
func (*HciCluster) ToHciClusterOutput ¶
func (i *HciCluster) ToHciClusterOutput() HciClusterOutput
func (*HciCluster) ToHciClusterOutputWithContext ¶
func (i *HciCluster) ToHciClusterOutputWithContext(ctx context.Context) HciClusterOutput
type HciClusterArgs ¶
type HciClusterArgs struct { // The ID of the Automanage Configuration assigned to the Azure Stack HCI Cluster. AutomanageConfigurationId pulumi.StringPtrInput // The Client ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created. ClientId pulumi.StringInput // The Azure Region where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created. Location pulumi.StringPtrInput // The name which should be used for this Azure Stack HCI Cluster. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // The name of the Resource Group where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringInput // A mapping of tags which should be assigned to the Azure Stack HCI Cluster. Tags pulumi.StringMapInput // The Tenant ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created. // // > **NOTE** If unspecified the Tenant ID of the Provider will be used. TenantId pulumi.StringPtrInput }
The set of arguments for constructing a HciCluster resource.
func (HciClusterArgs) ElementType ¶
func (HciClusterArgs) ElementType() reflect.Type
type HciClusterArray ¶
type HciClusterArray []HciClusterInput
func (HciClusterArray) ElementType ¶
func (HciClusterArray) ElementType() reflect.Type
func (HciClusterArray) ToHciClusterArrayOutput ¶
func (i HciClusterArray) ToHciClusterArrayOutput() HciClusterArrayOutput
func (HciClusterArray) ToHciClusterArrayOutputWithContext ¶
func (i HciClusterArray) ToHciClusterArrayOutputWithContext(ctx context.Context) HciClusterArrayOutput
type HciClusterArrayInput ¶
type HciClusterArrayInput interface { pulumi.Input ToHciClusterArrayOutput() HciClusterArrayOutput ToHciClusterArrayOutputWithContext(context.Context) HciClusterArrayOutput }
HciClusterArrayInput is an input type that accepts HciClusterArray and HciClusterArrayOutput values. You can construct a concrete instance of `HciClusterArrayInput` via:
HciClusterArray{ HciClusterArgs{...} }
type HciClusterArrayOutput ¶
type HciClusterArrayOutput struct{ *pulumi.OutputState }
func (HciClusterArrayOutput) ElementType ¶
func (HciClusterArrayOutput) ElementType() reflect.Type
func (HciClusterArrayOutput) Index ¶
func (o HciClusterArrayOutput) Index(i pulumi.IntInput) HciClusterOutput
func (HciClusterArrayOutput) ToHciClusterArrayOutput ¶
func (o HciClusterArrayOutput) ToHciClusterArrayOutput() HciClusterArrayOutput
func (HciClusterArrayOutput) ToHciClusterArrayOutputWithContext ¶
func (o HciClusterArrayOutput) ToHciClusterArrayOutputWithContext(ctx context.Context) HciClusterArrayOutput
type HciClusterInput ¶
type HciClusterInput interface { pulumi.Input ToHciClusterOutput() HciClusterOutput ToHciClusterOutputWithContext(ctx context.Context) HciClusterOutput }
type HciClusterMap ¶
type HciClusterMap map[string]HciClusterInput
func (HciClusterMap) ElementType ¶
func (HciClusterMap) ElementType() reflect.Type
func (HciClusterMap) ToHciClusterMapOutput ¶
func (i HciClusterMap) ToHciClusterMapOutput() HciClusterMapOutput
func (HciClusterMap) ToHciClusterMapOutputWithContext ¶
func (i HciClusterMap) ToHciClusterMapOutputWithContext(ctx context.Context) HciClusterMapOutput
type HciClusterMapInput ¶
type HciClusterMapInput interface { pulumi.Input ToHciClusterMapOutput() HciClusterMapOutput ToHciClusterMapOutputWithContext(context.Context) HciClusterMapOutput }
HciClusterMapInput is an input type that accepts HciClusterMap and HciClusterMapOutput values. You can construct a concrete instance of `HciClusterMapInput` via:
HciClusterMap{ "key": HciClusterArgs{...} }
type HciClusterMapOutput ¶
type HciClusterMapOutput struct{ *pulumi.OutputState }
func (HciClusterMapOutput) ElementType ¶
func (HciClusterMapOutput) ElementType() reflect.Type
func (HciClusterMapOutput) MapIndex ¶
func (o HciClusterMapOutput) MapIndex(k pulumi.StringInput) HciClusterOutput
func (HciClusterMapOutput) ToHciClusterMapOutput ¶
func (o HciClusterMapOutput) ToHciClusterMapOutput() HciClusterMapOutput
func (HciClusterMapOutput) ToHciClusterMapOutputWithContext ¶
func (o HciClusterMapOutput) ToHciClusterMapOutputWithContext(ctx context.Context) HciClusterMapOutput
type HciClusterOutput ¶
type HciClusterOutput struct{ *pulumi.OutputState }
func (HciClusterOutput) AutomanageConfigurationId ¶ added in v5.49.0
func (o HciClusterOutput) AutomanageConfigurationId() pulumi.StringPtrOutput
The ID of the Automanage Configuration assigned to the Azure Stack HCI Cluster.
func (HciClusterOutput) ClientId ¶ added in v5.5.0
func (o HciClusterOutput) ClientId() pulumi.StringOutput
The Client ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
func (HciClusterOutput) ElementType ¶
func (HciClusterOutput) ElementType() reflect.Type
func (HciClusterOutput) Location ¶ added in v5.5.0
func (o HciClusterOutput) Location() pulumi.StringOutput
The Azure Region where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
func (HciClusterOutput) Name ¶ added in v5.5.0
func (o HciClusterOutput) Name() pulumi.StringOutput
The name which should be used for this Azure Stack HCI Cluster. Changing this forces a new resource to be created.
func (HciClusterOutput) ResourceGroupName ¶ added in v5.5.0
func (o HciClusterOutput) ResourceGroupName() pulumi.StringOutput
The name of the Resource Group where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
func (HciClusterOutput) Tags ¶ added in v5.5.0
func (o HciClusterOutput) Tags() pulumi.StringMapOutput
A mapping of tags which should be assigned to the Azure Stack HCI Cluster.
func (HciClusterOutput) TenantId ¶ added in v5.5.0
func (o HciClusterOutput) TenantId() pulumi.StringOutput
The Tenant ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
> **NOTE** If unspecified the Tenant ID of the Provider will be used.
func (HciClusterOutput) ToHciClusterOutput ¶
func (o HciClusterOutput) ToHciClusterOutput() HciClusterOutput
func (HciClusterOutput) ToHciClusterOutputWithContext ¶
func (o HciClusterOutput) ToHciClusterOutputWithContext(ctx context.Context) HciClusterOutput
type HciClusterState ¶
type HciClusterState struct { // The ID of the Automanage Configuration assigned to the Azure Stack HCI Cluster. AutomanageConfigurationId pulumi.StringPtrInput // The Client ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created. ClientId pulumi.StringPtrInput // The Azure Region where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created. Location pulumi.StringPtrInput // The name which should be used for this Azure Stack HCI Cluster. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // The name of the Resource Group where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringPtrInput // A mapping of tags which should be assigned to the Azure Stack HCI Cluster. Tags pulumi.StringMapInput // The Tenant ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created. // // > **NOTE** If unspecified the Tenant ID of the Provider will be used. TenantId pulumi.StringPtrInput }
func (HciClusterState) ElementType ¶
func (HciClusterState) ElementType() reflect.Type
type LookupHciClusterArgs ¶ added in v5.58.0
type LookupHciClusterArgs struct { // The name of the Azure Stack HCI Cluster. Name string `pulumi:"name"` // The name of the Resource Group where the Azure Stack HCI Cluster exists. ResourceGroupName string `pulumi:"resourceGroupName"` }
A collection of arguments for invoking getHciCluster.
type LookupHciClusterOutputArgs ¶ added in v5.58.0
type LookupHciClusterOutputArgs struct { // The name of the Azure Stack HCI Cluster. Name pulumi.StringInput `pulumi:"name"` // The name of the Resource Group where the Azure Stack HCI Cluster exists. ResourceGroupName pulumi.StringInput `pulumi:"resourceGroupName"` }
A collection of arguments for invoking getHciCluster.
func (LookupHciClusterOutputArgs) ElementType ¶ added in v5.58.0
func (LookupHciClusterOutputArgs) ElementType() reflect.Type
type LookupHciClusterResult ¶ added in v5.58.0
type LookupHciClusterResult struct { // The ID of the Automanage Configuration assigned to the Azure Stack HCI Cluster. AutomanageConfigurationId string `pulumi:"automanageConfigurationId"` // The Client ID of the Azure Active Directory used by the Azure Stack HCI Cluster. ClientId string `pulumi:"clientId"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` // The Azure Region where the Azure Stack HCI Cluster exists. Location string `pulumi:"location"` Name string `pulumi:"name"` ResourceGroupName string `pulumi:"resourceGroupName"` // A mapping of tags assigned to the Azure Stack HCI Cluster. Tags map[string]string `pulumi:"tags"` // The Tenant ID of the Azure Active Directory used by the Azure Stack HCI Cluster. TenantId string `pulumi:"tenantId"` }
A collection of values returned by getHciCluster.
func LookupHciCluster ¶ added in v5.58.0
func LookupHciCluster(ctx *pulumi.Context, args *LookupHciClusterArgs, opts ...pulumi.InvokeOption) (*LookupHciClusterResult, error)
Use this data source to access information about an existing Azure Stack HCI Cluster instance.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/stack" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { example, err := stack.LookupHciCluster(ctx, &stack.LookupHciClusterArgs{ Name: "existing", ResourceGroupName: "existing", }, nil) if err != nil { return err } ctx.Export("id", example.Id) ctx.Export("location", example.Location) ctx.Export("clientId", example.ClientId) return nil }) }
```
type LookupHciClusterResultOutput ¶ added in v5.58.0
type LookupHciClusterResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getHciCluster.
func LookupHciClusterOutput ¶ added in v5.58.0
func LookupHciClusterOutput(ctx *pulumi.Context, args LookupHciClusterOutputArgs, opts ...pulumi.InvokeOption) LookupHciClusterResultOutput
func (LookupHciClusterResultOutput) AutomanageConfigurationId ¶ added in v5.58.0
func (o LookupHciClusterResultOutput) AutomanageConfigurationId() pulumi.StringOutput
The ID of the Automanage Configuration assigned to the Azure Stack HCI Cluster.
func (LookupHciClusterResultOutput) ClientId ¶ added in v5.58.0
func (o LookupHciClusterResultOutput) ClientId() pulumi.StringOutput
The Client ID of the Azure Active Directory used by the Azure Stack HCI Cluster.
func (LookupHciClusterResultOutput) ElementType ¶ added in v5.58.0
func (LookupHciClusterResultOutput) ElementType() reflect.Type
func (LookupHciClusterResultOutput) Id ¶ added in v5.58.0
func (o LookupHciClusterResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (LookupHciClusterResultOutput) Location ¶ added in v5.58.0
func (o LookupHciClusterResultOutput) Location() pulumi.StringOutput
The Azure Region where the Azure Stack HCI Cluster exists.
func (LookupHciClusterResultOutput) Name ¶ added in v5.58.0
func (o LookupHciClusterResultOutput) Name() pulumi.StringOutput
func (LookupHciClusterResultOutput) ResourceGroupName ¶ added in v5.58.0
func (o LookupHciClusterResultOutput) ResourceGroupName() pulumi.StringOutput
func (LookupHciClusterResultOutput) Tags ¶ added in v5.58.0
func (o LookupHciClusterResultOutput) Tags() pulumi.StringMapOutput
A mapping of tags assigned to the Azure Stack HCI Cluster.
func (LookupHciClusterResultOutput) TenantId ¶ added in v5.58.0
func (o LookupHciClusterResultOutput) TenantId() pulumi.StringOutput
The Tenant ID of the Azure Active Directory used by the Azure Stack HCI Cluster.
func (LookupHciClusterResultOutput) ToLookupHciClusterResultOutput ¶ added in v5.58.0
func (o LookupHciClusterResultOutput) ToLookupHciClusterResultOutput() LookupHciClusterResultOutput
func (LookupHciClusterResultOutput) ToLookupHciClusterResultOutputWithContext ¶ added in v5.58.0
func (o LookupHciClusterResultOutput) ToLookupHciClusterResultOutputWithContext(ctx context.Context) LookupHciClusterResultOutput