azure-native.networkcloud.Volume
Explore with Pulumi AI
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",
    });
});
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
	})
}
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());
    }
}
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",
});
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")
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
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 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 examplevolumeResourceResourceFromNetworkcloud = new AzureNative.NetworkCloud.Volume("examplevolumeResourceResourceFromNetworkcloud", new()
{
    ExtendedLocation = new AzureNative.NetworkCloud.Inputs.ExtendedLocationArgs
    {
        Name = "string",
        Type = "string",
    },
    ResourceGroupName = "string",
    SizeMiB = 0,
    Location = "string",
    Tags = 
    {
        { "string", "string" },
    },
    VolumeName = "string",
});
example, err := networkcloud.NewVolume(ctx, "examplevolumeResourceResourceFromNetworkcloud", &networkcloud.VolumeArgs{
	ExtendedLocation: &networkcloud.ExtendedLocationArgs{
		Name: pulumi.String("string"),
		Type: pulumi.String("string"),
	},
	ResourceGroupName: pulumi.String("string"),
	SizeMiB:           pulumi.Float64(0),
	Location:          pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VolumeName: pulumi.String("string"),
})
var examplevolumeResourceResourceFromNetworkcloud = new Volume("examplevolumeResourceResourceFromNetworkcloud", VolumeArgs.builder()
    .extendedLocation(ExtendedLocationArgs.builder()
        .name("string")
        .type("string")
        .build())
    .resourceGroupName("string")
    .sizeMiB(0)
    .location("string")
    .tags(Map.of("string", "string"))
    .volumeName("string")
    .build());
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")
const examplevolumeResourceResourceFromNetworkcloud = new azure_native.networkcloud.Volume("examplevolumeResourceResourceFromNetworkcloud", {
    extendedLocation: {
        name: "string",
        type: "string",
    },
    resourceGroupName: "string",
    sizeMiB: 0,
    location: "string",
    tags: {
        string: "string",
    },
    volumeName: "string",
});
type: azure-native:networkcloud:Volume
properties:
    extendedLocation:
        name: string
        type: string
    location: string
    resourceGroupName: string
    sizeMiB: 0
    tags:
        string: 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
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 Pulumi.Azure Native. Network Cloud. Inputs. Extended Location 
- The extended location of the cluster associated with the resource.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- SizeMi doubleB 
- The size of the allocation for this volume in Mebibytes.
- Location string
- The geo-location where the resource lives
- Dictionary<string, string>
- Resource tags.
- VolumeName string
- The name of the volume.
- ExtendedLocation ExtendedLocation Args 
- The extended location of the cluster associated with the resource.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- SizeMi float64B 
- The size of the allocation for this volume in Mebibytes.
- Location string
- The geo-location where the resource lives
- map[string]string
- Resource tags.
- VolumeName string
- The name of the volume.
- extendedLocation ExtendedLocation 
- The extended location of the cluster associated with the resource.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- sizeMi DoubleB 
- The size of the allocation for this volume in Mebibytes.
- location String
- The geo-location where the resource lives
- Map<String,String>
- Resource tags.
- volumeName String
- The name of the volume.
- extendedLocation ExtendedLocation 
- The extended location of the cluster associated with the resource.
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- sizeMi numberB 
- The size of the allocation for this volume in Mebibytes.
- location string
- The geo-location where the resource lives
- {[key: string]: string}
- Resource tags.
- volumeName string
- The name of the volume.
- extended_location ExtendedLocation Args 
- The extended location of the cluster associated with the resource.
- resource_group_ strname 
- The name of the resource group. The name is case insensitive.
- size_mi_ floatb 
- The size of the allocation for this volume in Mebibytes.
- location str
- The geo-location where the resource lives
- Mapping[str, str]
- Resource tags.
- volume_name str
- The name of the volume.
- extendedLocation Property Map
- The extended location of the cluster associated with the resource.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- sizeMi NumberB 
- The size of the allocation for this volume in Mebibytes.
- location String
- The geo-location where the resource lives
- Map<String>
- Resource tags.
- volumeName 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.
- DetailedStatus stringMessage 
- 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.Azure Native. Network Cloud. Outputs. System Data Response 
- 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.
- DetailedStatus stringMessage 
- 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 SystemData Response 
- 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.
- detailedStatus StringMessage 
- 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 SystemData Response 
- 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.
- detailedStatus stringMessage 
- 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 SystemData Response 
- 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_ strmessage 
- 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 SystemData Response 
- 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.
- detailedStatus StringMessage 
- 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    
ExtendedLocationResponse, ExtendedLocationResponseArgs      
SystemDataResponse, SystemDataResponseArgs      
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- 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_ strtype 
- 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_ strby_ type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0