1. Packages
  2. Azure Native
  3. API Docs
  4. containerstorage
  5. Volume
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

azure-native.containerstorage.Volume

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

    Concrete proxy resource types can be created by aliasing this type using a specific property type. Azure REST API version: 2023-07-01-preview. Prior API version in Azure Native 1.x: 2023-03-01-preview.

    Example Usage

    Volumes_CreateOrUpdate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var volume = new AzureNative.ContainerStorage.Volume("volume", new()
        {
            CapacityGiB = 25838,
            Labels = 
            {
                { "key2039", "value2039" },
            },
            PoolName = "test-pool",
            ResourceGroupName = "test-rg",
            VolumeName = "test-volume",
        });
    
    });
    
    package main
    
    import (
    	containerstorage "github.com/pulumi/pulumi-azure-native-sdk/containerstorage/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := containerstorage.NewVolume(ctx, "volume", &containerstorage.VolumeArgs{
    			CapacityGiB: pulumi.Float64(25838),
    			Labels: pulumi.StringMap{
    				"key2039": pulumi.String("value2039"),
    			},
    			PoolName:          pulumi.String("test-pool"),
    			ResourceGroupName: pulumi.String("test-rg"),
    			VolumeName:        pulumi.String("test-volume"),
    		})
    		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.containerstorage.Volume;
    import com.pulumi.azurenative.containerstorage.VolumeArgs;
    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 volume = new Volume("volume", VolumeArgs.builder()
                .capacityGiB(25838)
                .labels(Map.of("key2039", "value2039"))
                .poolName("test-pool")
                .resourceGroupName("test-rg")
                .volumeName("test-volume")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    volume = azure_native.containerstorage.Volume("volume",
        capacity_gi_b=25838,
        labels={
            "key2039": "value2039",
        },
        pool_name="test-pool",
        resource_group_name="test-rg",
        volume_name="test-volume")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const volume = new azure_native.containerstorage.Volume("volume", {
        capacityGiB: 25838,
        labels: {
            key2039: "value2039",
        },
        poolName: "test-pool",
        resourceGroupName: "test-rg",
        volumeName: "test-volume",
    });
    
    resources:
      volume:
        type: azure-native:containerstorage:Volume
        properties:
          capacityGiB: 25838
          labels:
            key2039: value2039
          poolName: test-pool
          resourceGroupName: test-rg
          volumeName: test-volume
    

    Create Volume Resource

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

    Constructor syntax

    new Volume(name: string, args: VolumeArgs, opts?: CustomResourceOptions);
    @overload
    def Volume(resource_name: str,
               args: VolumeArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Volume(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               capacity_gi_b: Optional[float] = None,
               labels: Optional[Mapping[str, str]] = None,
               pool_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               volume_name: Optional[str] = None)
    func NewVolume(ctx *Context, name string, args VolumeArgs, opts ...ResourceOption) (*Volume, error)
    public Volume(string name, VolumeArgs args, CustomResourceOptions? opts = null)
    public Volume(String name, VolumeArgs args)
    public Volume(String name, VolumeArgs args, CustomResourceOptions options)
    
    type: azure-native:containerstorage:Volume
    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 VolumeArgs
    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 VolumeArgs
    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 VolumeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VolumeArgs
    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 volumeResource = new AzureNative.ContainerStorage.Volume("volumeResource", new()
    {
        CapacityGiB = 0,
        Labels = 
        {
            { "string", "string" },
        },
        PoolName = "string",
        ResourceGroupName = "string",
        VolumeName = "string",
    });
    
    example, err := containerstorage.NewVolume(ctx, "volumeResource", &containerstorage.VolumeArgs{
    	CapacityGiB: pulumi.Float64(0),
    	Labels: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	PoolName:          pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	VolumeName:        pulumi.String("string"),
    })
    
    var volumeResource = new Volume("volumeResource", VolumeArgs.builder()
        .capacityGiB(0)
        .labels(Map.of("string", "string"))
        .poolName("string")
        .resourceGroupName("string")
        .volumeName("string")
        .build());
    
    volume_resource = azure_native.containerstorage.Volume("volumeResource",
        capacity_gi_b=0,
        labels={
            "string": "string",
        },
        pool_name="string",
        resource_group_name="string",
        volume_name="string")
    
    const volumeResource = new azure_native.containerstorage.Volume("volumeResource", {
        capacityGiB: 0,
        labels: {
            string: "string",
        },
        poolName: "string",
        resourceGroupName: "string",
        volumeName: "string",
    });
    
    type: azure-native:containerstorage:Volume
    properties:
        capacityGiB: 0
        labels:
            string: string
        poolName: string
        resourceGroupName: string
        volumeName: string
    

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

    CapacityGiB double
    Requested capacity in GiB
    Labels Dictionary<string, string>
    String KV pairs indicating labels
    PoolName string
    Pool Object
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VolumeName string
    Volume Resource
    CapacityGiB float64
    Requested capacity in GiB
    Labels map[string]string
    String KV pairs indicating labels
    PoolName string
    Pool Object
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VolumeName string
    Volume Resource
    capacityGiB Double
    Requested capacity in GiB
    labels Map<String,String>
    String KV pairs indicating labels
    poolName String
    Pool Object
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    volumeName String
    Volume Resource
    capacityGiB number
    Requested capacity in GiB
    labels {[key: string]: string}
    String KV pairs indicating labels
    poolName string
    Pool Object
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    volumeName string
    Volume Resource
    capacity_gi_b float
    Requested capacity in GiB
    labels Mapping[str, str]
    String KV pairs indicating labels
    pool_name str
    Pool Object
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    volume_name str
    Volume Resource
    capacityGiB Number
    Requested capacity in GiB
    labels Map<String>
    String KV pairs indicating labels
    poolName String
    Pool Object
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    volumeName String
    Volume Resource

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The status of the last operation.
    Status Pulumi.AzureNative.ContainerStorage.Outputs.ResourceOperationalStatusResponse
    The status of the resource.
    SystemData Pulumi.AzureNative.ContainerStorage.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"
    VolumeType Pulumi.AzureNative.ContainerStorage.Outputs.VolumeTypeResponse
    Properties of the volume
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The status of the last operation.
    Status ResourceOperationalStatusResponse
    The status of the 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"
    VolumeType VolumeTypeResponse
    Properties of the volume
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The status of the last operation.
    status ResourceOperationalStatusResponse
    The status of the 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"
    volumeType VolumeTypeResponse
    Properties of the volume
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    provisioningState string
    The status of the last operation.
    status ResourceOperationalStatusResponse
    The status of the 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"
    volumeType VolumeTypeResponse
    Properties of the volume
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    provisioning_state str
    The status of the last operation.
    status ResourceOperationalStatusResponse
    The status of the 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"
    volume_type VolumeTypeResponse
    Properties of the volume
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The status of the last operation.
    status Property Map
    The status of the 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"
    volumeType Property Map
    Properties of the volume

    Supporting Types

    ElasticSanVolumePropertiesResponse, ElasticSanVolumePropertiesResponseArgs

    TargetIqn string
    iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server"
    TargetPortalHostname string
    iSCSI Target Portal Host Name
    TargetPortalPort int
    iSCSI Target Portal Port
    TargetIqn string
    iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server"
    TargetPortalHostname string
    iSCSI Target Portal Host Name
    TargetPortalPort int
    iSCSI Target Portal Port
    targetIqn String
    iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server"
    targetPortalHostname String
    iSCSI Target Portal Host Name
    targetPortalPort Integer
    iSCSI Target Portal Port
    targetIqn string
    iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server"
    targetPortalHostname string
    iSCSI Target Portal Host Name
    targetPortalPort number
    iSCSI Target Portal Port
    target_iqn str
    iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server"
    target_portal_hostname str
    iSCSI Target Portal Host Name
    target_portal_port int
    iSCSI Target Portal Port
    targetIqn String
    iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server"
    targetPortalHostname String
    iSCSI Target Portal Host Name
    targetPortalPort Number
    iSCSI Target Portal Port

    ResourceOperationalStatusResponse, ResourceOperationalStatusResponseArgs

    State string
    state of the resource
    Message string
    Reason for state.
    State string
    state of the resource
    Message string
    Reason for state.
    state String
    state of the resource
    message String
    Reason for state.
    state string
    state of the resource
    message string
    Reason for state.
    state str
    state of the resource
    message str
    Reason for state.
    state String
    state of the resource
    message String
    Reason for state.

    SystemDataResponse, SystemDataResponseArgs

    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.
    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.

    VolumeTypeResponse, VolumeTypeResponseArgs

    ElasticSan ElasticSanVolumePropertiesResponse
    Properties of the ElasticSAN iSCSI target
    elasticSan ElasticSanVolumePropertiesResponse
    Properties of the ElasticSAN iSCSI target
    elasticSan ElasticSanVolumePropertiesResponse
    Properties of the ElasticSAN iSCSI target
    elastic_san ElasticSanVolumePropertiesResponse
    Properties of the ElasticSAN iSCSI target
    elasticSan Property Map
    Properties of the ElasticSAN iSCSI target

    Import

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

    $ pulumi import azure-native:containerstorage:Volume test-volume /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumes/{volumeName} 
    

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

    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 v1 docs if using the v1 version of this package.
    Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi