Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. stack
  5. HciStoragePath

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.stack.HciStoragePath

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages an Azure Stack HCI Storage Path.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-rg",
    location: "West Europe",
});
const exampleHciStoragePath = new azure.stack.HciStoragePath("example", {
    name: "example-sp",
    resourceGroupName: example.name,
    location: example.location,
    customLocationId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/cl1",
    path: "C:\\ClusterStorage\\UserStorage_2\\sp-example",
    tags: {
        foo: "bar",
    },
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-rg",
    location="West Europe")
example_hci_storage_path = azure.stack.HciStoragePath("example",
    name="example-sp",
    resource_group_name=example.name,
    location=example.location,
    custom_location_id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/cl1",
    path="C:\\ClusterStorage\\UserStorage_2\\sp-example",
    tags={
        "foo": "bar",
    })

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/stack"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-rg"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = stack.NewHciStoragePath(ctx, "example", &stack.HciStoragePathArgs{
			Name:              pulumi.String("example-sp"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			CustomLocationId:  pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/cl1"),
			Path:              pulumi.String("C:\\ClusterStorage\\UserStorage_2\\sp-example"),
			Tags: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-rg",
        Location = "West Europe",
    });

    var exampleHciStoragePath = new Azure.Stack.HciStoragePath("example", new()
    {
        Name = "example-sp",
        ResourceGroupName = example.Name,
        Location = example.Location,
        CustomLocationId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/cl1",
        Path = "C:\\ClusterStorage\\UserStorage_2\\sp-example",
        Tags = 
        {
            { "foo", "bar" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.stack.HciStoragePath;
import com.pulumi.azure.stack.HciStoragePathArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-rg")
            .location("West Europe")
            .build());

        var exampleHciStoragePath = new HciStoragePath("exampleHciStoragePath", HciStoragePathArgs.builder()
            .name("example-sp")
            .resourceGroupName(example.name())
            .location(example.location())
            .customLocationId("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/cl1")
            .path("C:\\ClusterStorage\\UserStorage_2\\sp-example")
            .tags(Map.of("foo", "bar"))
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-rg
      location: West Europe
  exampleHciStoragePath:
    type: azure:stack:HciStoragePath
    name: example
    properties:
      name: example-sp
      resourceGroupName: ${example.name}
      location: ${example.location}
      customLocationId: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/cl1
      path: C:\ClusterStorage\UserStorage_2\sp-example
      tags:
        foo: bar

    Create HciStoragePath Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new HciStoragePath(name: string, args: HciStoragePathArgs, opts?: CustomResourceOptions);
    @overload
def HciStoragePath(resource_name: str,
                   args: HciStoragePathArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def HciStoragePath(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   custom_location_id: Optional[str] = None,
                   path: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   location: Optional[str] = None,
                   name: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None)
    func NewHciStoragePath(ctx *Context, name string, args HciStoragePathArgs, opts ...ResourceOption) (*HciStoragePath, error)
    public HciStoragePath(string name, HciStoragePathArgs args, CustomResourceOptions? opts = null)
    public HciStoragePath(String name, HciStoragePathArgs args)
public HciStoragePath(String name, HciStoragePathArgs args, CustomResourceOptions options)

    type: azure:stack:HciStoragePath
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 HciStoragePathArgs
    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 HciStoragePathArgs
    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 HciStoragePathArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HciStoragePathArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HciStoragePathArgs
    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 hciStoragePathResource = new Azure.Stack.HciStoragePath("hciStoragePathResource", new()
{
    CustomLocationId = "string",
    Path = "string",
    ResourceGroupName = "string",
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := stack.NewHciStoragePath(ctx, "hciStoragePathResource", &stack.HciStoragePathArgs{
	CustomLocationId:  pulumi.String("string"),
	Path:              pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	Location:          pulumi.String("string"),
	Name:              pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var hciStoragePathResource = new HciStoragePath("hciStoragePathResource", HciStoragePathArgs.builder()
    .customLocationId("string")
    .path("string")
    .resourceGroupName("string")
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    hci_storage_path_resource = azure.stack.HciStoragePath("hciStoragePathResource",
    custom_location_id="string",
    path="string",
    resource_group_name="string",
    location="string",
    name="string",
    tags={
        "string": "string",
    })

    const hciStoragePathResource = new azure.stack.HciStoragePath("hciStoragePathResource", {
    customLocationId: "string",
    path: "string",
    resourceGroupName: "string",
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: azure:stack:HciStoragePath
properties:
    customLocationId: string
    location: string
    name: string
    path: string
    resourceGroupName: string
    tags:
        string: string

    HciStoragePath 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 HciStoragePath resource accepts the following input properties:

    CustomLocationId string
    The ID of Custom Location where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    Path string
    The file path on the disk to create the Storage Path. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the Resource Group where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    Location string
    The Azure Region where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    Name string
    The name which should be used for this Azure Stack HCI Storage Path. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Azure Stack HCI Storage Path.
    CustomLocationId string
    The ID of Custom Location where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    Path string
    The file path on the disk to create the Storage Path. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the Resource Group where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    Location string
    The Azure Region where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    Name string
    The name which should be used for this Azure Stack HCI Storage Path. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Azure Stack HCI Storage Path.
    customLocationId String
    The ID of Custom Location where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    path String
    The file path on the disk to create the Storage Path. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the Resource Group where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    location String
    The Azure Region where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    name String
    The name which should be used for this Azure Stack HCI Storage Path. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Azure Stack HCI Storage Path.
    customLocationId string
    The ID of Custom Location where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    path string
    The file path on the disk to create the Storage Path. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the Resource Group where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    location string
    The Azure Region where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    name string
    The name which should be used for this Azure Stack HCI Storage Path. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Azure Stack HCI Storage Path.
    custom_location_id str
    The ID of Custom Location where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    path str
    The file path on the disk to create the Storage Path. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the Resource Group where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    location str
    The Azure Region where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    name str
    The name which should be used for this Azure Stack HCI Storage Path. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Azure Stack HCI Storage Path.
    customLocationId String
    The ID of Custom Location where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    path String
    The file path on the disk to create the Storage Path. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the Resource Group where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    location String
    The Azure Region where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    name String
    The name which should be used for this Azure Stack HCI Storage Path. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Azure Stack HCI Storage Path.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing HciStoragePath Resource

    Get an existing HciStoragePath resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: HciStoragePathState, opts?: CustomResourceOptions): HciStoragePath
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        custom_location_id: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        path: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> HciStoragePath
    func GetHciStoragePath(ctx *Context, name string, id IDInput, state *HciStoragePathState, opts ...ResourceOption) (*HciStoragePath, error)
    public static HciStoragePath Get(string name, Input<string> id, HciStoragePathState? state, CustomResourceOptions? opts = null)
    public static HciStoragePath get(String name, Output<String> id, HciStoragePathState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CustomLocationId string
    The ID of Custom Location where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    Location string
    The Azure Region where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    Name string
    The name which should be used for this Azure Stack HCI Storage Path. Changing this forces a new resource to be created.
    Path string
    The file path on the disk to create the Storage Path. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the Resource Group where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Azure Stack HCI Storage Path.
    CustomLocationId string
    The ID of Custom Location where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    Location string
    The Azure Region where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    Name string
    The name which should be used for this Azure Stack HCI Storage Path. Changing this forces a new resource to be created.
    Path string
    The file path on the disk to create the Storage Path. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the Resource Group where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Azure Stack HCI Storage Path.
    customLocationId String
    The ID of Custom Location where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    location String
    The Azure Region where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    name String
    The name which should be used for this Azure Stack HCI Storage Path. Changing this forces a new resource to be created.
    path String
    The file path on the disk to create the Storage Path. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the Resource Group where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Azure Stack HCI Storage Path.
    customLocationId string
    The ID of Custom Location where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    location string
    The Azure Region where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    name string
    The name which should be used for this Azure Stack HCI Storage Path. Changing this forces a new resource to be created.
    path string
    The file path on the disk to create the Storage Path. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the Resource Group where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Azure Stack HCI Storage Path.
    custom_location_id str
    The ID of Custom Location where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    location str
    The Azure Region where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    name str
    The name which should be used for this Azure Stack HCI Storage Path. Changing this forces a new resource to be created.
    path str
    The file path on the disk to create the Storage Path. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the Resource Group where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Azure Stack HCI Storage Path.
    customLocationId String
    The ID of Custom Location where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    location String
    The Azure Region where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    name String
    The name which should be used for this Azure Stack HCI Storage Path. Changing this forces a new resource to be created.
    path String
    The file path on the disk to create the Storage Path. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the Resource Group where the Azure Stack HCI Storage Path should exist. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Azure Stack HCI Storage Path.

    Import

    Azure Stack HCI Storage Paths can be imported using the resource id, e.g.

    $ pulumi import azure:stack/hciStoragePath:HciStoragePath example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AzureStackHCI/storageContainers/storage1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure