Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. networkcloud
  5. Volume
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.networkcloud.Volume

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Azure REST API version: 2023-10-01-preview. Prior API version in Azure Native 1.x: 2022-12-12-preview.

Other available API versions: 2023-07-01, 2024-06-01-preview, 2024-07-01, 2024-10-01-preview.

Example Usage

Create or update volume

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

return await Deployment.RunAsync(() => 
{
    var volume = new AzureNative.NetworkCloud.Volume("volume", new()
    {
        ExtendedLocation = new AzureNative.NetworkCloud.Inputs.ExtendedLocationArgs
        {
            Name = "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName",
            Type = "CustomLocation",
        },
        Location = "location",
        ResourceGroupName = "resourceGroupName",
        SizeMiB = 10000,
        Tags = 
        {
            { "key1", "myvalue1" },
            { "key2", "myvalue2" },
        },
        VolumeName = "volumeName",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkcloud.NewVolume(ctx, "volume", &networkcloud.VolumeArgs{
			ExtendedLocation: &networkcloud.ExtendedLocationArgs{
				Name: pulumi.String("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"),
				Type: pulumi.String("CustomLocation"),
			},
			Location:          pulumi.String("location"),
			ResourceGroupName: pulumi.String("resourceGroupName"),
			SizeMiB:           pulumi.Float64(10000),
			Tags: pulumi.StringMap{
				"key1": pulumi.String("myvalue1"),
				"key2": pulumi.String("myvalue2"),
			},
			VolumeName: pulumi.String("volumeName"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.networkcloud.Volume;
import com.pulumi.azurenative.networkcloud.VolumeArgs;
import com.pulumi.azurenative.networkcloud.inputs.ExtendedLocationArgs;
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()
            .extendedLocation(ExtendedLocationArgs.builder()
                .name("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName")
                .type("CustomLocation")
                .build())
            .location("location")
            .resourceGroupName("resourceGroupName")
            .sizeMiB(10000)
            .tags(Map.ofEntries(
                Map.entry("key1", "myvalue1"),
                Map.entry("key2", "myvalue2")
            ))
            .volumeName("volumeName")
            .build());

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

const volume = new azure_native.networkcloud.Volume("volume", {
    extendedLocation: {
        name: "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName",
        type: "CustomLocation",
    },
    location: "location",
    resourceGroupName: "resourceGroupName",
    sizeMiB: 10000,
    tags: {
        key1: "myvalue1",
        key2: "myvalue2",
    },
    volumeName: "volumeName",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

volume = azure_native.networkcloud.Volume("volume",
    extended_location={
        "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName",
        "type": "CustomLocation",
    },
    location="location",
    resource_group_name="resourceGroupName",
    size_mi_b=10000,
    tags={
        "key1": "myvalue1",
        "key2": "myvalue2",
    },
    volume_name="volumeName")
Copy
resources:
  volume:
    type: azure-native:networkcloud:Volume
    properties:
      extendedLocation:
        name: /subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName
        type: CustomLocation
      location: location
      resourceGroupName: resourceGroupName
      sizeMiB: 10000
      tags:
        key1: myvalue1
        key2: myvalue2
      volumeName: volumeName
Copy

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,
           extended_location: Optional[ExtendedLocationArgs] = None,
           resource_group_name: Optional[str] = None,
           size_mi_b: Optional[float] = None,
           location: Optional[str] = None,
           tags: Optional[Mapping[str, 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:networkcloud:Volume
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. VolumeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. VolumeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. VolumeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 examplevolumeResourceResourceFromNetworkcloud = new AzureNative.Networkcloud.Volume("examplevolumeResourceResourceFromNetworkcloud", new()
{
    ExtendedLocation = 
    {
        { "name", "string" },
        { "type", "string" },
    },
    ResourceGroupName = "string",
    SizeMiB = 0,
    Location = "string",
    Tags = 
    {
        { "string", "string" },
    },
    VolumeName = "string",
});
Copy
example, err := networkcloud.NewVolume(ctx, "examplevolumeResourceResourceFromNetworkcloud", &networkcloud.VolumeArgs{
	ExtendedLocation: map[string]interface{}{
		"name": "string",
		"type": "string",
	},
	ResourceGroupName: "string",
	SizeMiB:           0,
	Location:          "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
	VolumeName: "string",
})
Copy
var examplevolumeResourceResourceFromNetworkcloud = new Volume("examplevolumeResourceResourceFromNetworkcloud", VolumeArgs.builder()
    .extendedLocation(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .resourceGroupName("string")
    .sizeMiB(0)
    .location("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .volumeName("string")
    .build());
Copy
examplevolume_resource_resource_from_networkcloud = azure_native.networkcloud.Volume("examplevolumeResourceResourceFromNetworkcloud",
    extended_location={
        name: string,
        type: string,
    },
    resource_group_name=string,
    size_mi_b=0,
    location=string,
    tags={
        string: string,
    },
    volume_name=string)
Copy
const examplevolumeResourceResourceFromNetworkcloud = new azure_native.networkcloud.Volume("examplevolumeResourceResourceFromNetworkcloud", {
    extendedLocation: {
        name: "string",
        type: "string",
    },
    resourceGroupName: "string",
    sizeMiB: 0,
    location: "string",
    tags: {
        string: "string",
    },
    volumeName: "string",
});
Copy
type: azure-native:networkcloud:Volume
properties:
    extendedLocation:
        name: string
        type: string
    location: string
    resourceGroupName: string
    sizeMiB: 0
    tags:
        string: string
    volumeName: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Volume resource accepts the following input properties:

ExtendedLocation This property is required. Pulumi.AzureNative.NetworkCloud.Inputs.ExtendedLocation
The extended location of the cluster associated with the resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SizeMiB
This property is required.
Changes to this property will trigger replacement.
double
The size of the allocation for this volume in Mebibytes.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
Tags Dictionary<string, string>
Resource tags.
VolumeName Changes to this property will trigger replacement. string
The name of the volume.
ExtendedLocation This property is required. ExtendedLocationArgs
The extended location of the cluster associated with the resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SizeMiB
This property is required.
Changes to this property will trigger replacement.
float64
The size of the allocation for this volume in Mebibytes.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
Tags map[string]string
Resource tags.
VolumeName Changes to this property will trigger replacement. string
The name of the volume.
extendedLocation This property is required. ExtendedLocation
The extended location of the cluster associated with the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
sizeMiB
This property is required.
Changes to this property will trigger replacement.
Double
The size of the allocation for this volume in Mebibytes.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
tags Map<String,String>
Resource tags.
volumeName Changes to this property will trigger replacement. String
The name of the volume.
extendedLocation This property is required. ExtendedLocation
The extended location of the cluster associated with the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
sizeMiB
This property is required.
Changes to this property will trigger replacement.
number
The size of the allocation for this volume in Mebibytes.
location Changes to this property will trigger replacement. string
The geo-location where the resource lives
tags {[key: string]: string}
Resource tags.
volumeName Changes to this property will trigger replacement. string
The name of the volume.
extended_location This property is required. ExtendedLocationArgs
The extended location of the cluster associated with the resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
size_mi_b
This property is required.
Changes to this property will trigger replacement.
float
The size of the allocation for this volume in Mebibytes.
location Changes to this property will trigger replacement. str
The geo-location where the resource lives
tags Mapping[str, str]
Resource tags.
volume_name Changes to this property will trigger replacement. str
The name of the volume.
extendedLocation This property is required. Property Map
The extended location of the cluster associated with the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
sizeMiB
This property is required.
Changes to this property will trigger replacement.
Number
The size of the allocation for this volume in Mebibytes.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
tags Map<String>
Resource tags.
volumeName Changes to this property will trigger replacement. String
The name of the volume.

Outputs

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

AttachedTo List<string>
The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters.
DetailedStatus string
The more detailed status of the volume.
DetailedStatusMessage string
The descriptive message about the current detailed status.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
The provisioning state of the volume.
SerialNumber string
The unique identifier of the volume.
SystemData Pulumi.AzureNative.NetworkCloud.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"
AttachedTo []string
The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters.
DetailedStatus string
The more detailed status of the volume.
DetailedStatusMessage string
The descriptive message about the current detailed status.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
The provisioning state of the volume.
SerialNumber string
The unique identifier of the volume.
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"
attachedTo List<String>
The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters.
detailedStatus String
The more detailed status of the volume.
detailedStatusMessage String
The descriptive message about the current detailed status.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
The provisioning state of the volume.
serialNumber String
The unique identifier of the volume.
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"
attachedTo string[]
The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters.
detailedStatus string
The more detailed status of the volume.
detailedStatusMessage string
The descriptive message about the current detailed status.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
provisioningState string
The provisioning state of the volume.
serialNumber string
The unique identifier of the volume.
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"
attached_to Sequence[str]
The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters.
detailed_status str
The more detailed status of the volume.
detailed_status_message str
The descriptive message about the current detailed status.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
provisioning_state str
The provisioning state of the volume.
serial_number str
The unique identifier of the volume.
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"
attachedTo List<String>
The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters.
detailedStatus String
The more detailed status of the volume.
detailedStatusMessage String
The descriptive message about the current detailed status.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
The provisioning state of the volume.
serialNumber String
The unique identifier of the volume.
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"

Supporting Types

ExtendedLocation
, ExtendedLocationArgs

Name This property is required. string
The resource ID of the extended location on which the resource will be created.
Type This property is required. string
The extended location type, for example, CustomLocation.
Name This property is required. string
The resource ID of the extended location on which the resource will be created.
Type This property is required. string
The extended location type, for example, CustomLocation.
name This property is required. String
The resource ID of the extended location on which the resource will be created.
type This property is required. String
The extended location type, for example, CustomLocation.
name This property is required. string
The resource ID of the extended location on which the resource will be created.
type This property is required. string
The extended location type, for example, CustomLocation.
name This property is required. str
The resource ID of the extended location on which the resource will be created.
type This property is required. str
The extended location type, for example, CustomLocation.
name This property is required. String
The resource ID of the extended location on which the resource will be created.
type This property is required. String
The extended location type, for example, CustomLocation.

ExtendedLocationResponse
, ExtendedLocationResponseArgs

Name This property is required. string
The resource ID of the extended location on which the resource will be created.
Type This property is required. string
The extended location type, for example, CustomLocation.
Name This property is required. string
The resource ID of the extended location on which the resource will be created.
Type This property is required. string
The extended location type, for example, CustomLocation.
name This property is required. String
The resource ID of the extended location on which the resource will be created.
type This property is required. String
The extended location type, for example, CustomLocation.
name This property is required. string
The resource ID of the extended location on which the resource will be created.
type This property is required. string
The extended location type, for example, CustomLocation.
name This property is required. str
The resource ID of the extended location on which the resource will be created.
type This property is required. str
The extended location type, for example, CustomLocation.
name This property is required. String
The resource ID of the extended location on which the resource will be created.
type This property is required. String
The extended location type, for example, CustomLocation.

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.

Import

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

$ pulumi import azure-native:networkcloud:Volume volumeName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/volumes/{volumeName}
Copy

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

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native