azure-native.servicefabricmesh.Volume
Explore with Pulumi AI
This type describes a volume resource. Azure REST API version: 2018-09-01-preview. Prior API version in Azure Native 1.x: 2018-09-01-preview.
Example Usage
CreateOrUpdateVolume
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var volume = new AzureNative.ServiceFabricMesh.Volume("volume", new()
    {
        AzureFileParameters = new AzureNative.ServiceFabricMesh.Inputs.VolumeProviderParametersAzureFileArgs
        {
            AccountKey = "provide-account-key-here",
            AccountName = "sbzdemoaccount",
            ShareName = "sharel",
        },
        Description = "Service Fabric Mesh sample volume.",
        Location = "EastUS",
        Provider = AzureNative.ServiceFabricMesh.VolumeProvider.SFAzureFile,
        ResourceGroupName = "sbz_demo",
        Tags = null,
        VolumeResourceName = "sampleVolume",
    });
});
package main
import (
	servicefabricmesh "github.com/pulumi/pulumi-azure-native-sdk/servicefabricmesh/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := servicefabricmesh.NewVolume(ctx, "volume", &servicefabricmesh.VolumeArgs{
			AzureFileParameters: &servicefabricmesh.VolumeProviderParametersAzureFileArgs{
				AccountKey:  pulumi.String("provide-account-key-here"),
				AccountName: pulumi.String("sbzdemoaccount"),
				ShareName:   pulumi.String("sharel"),
			},
			Description:        pulumi.String("Service Fabric Mesh sample volume."),
			Location:           pulumi.String("EastUS"),
			Provider:           pulumi.String(servicefabricmesh.VolumeProviderSFAzureFile),
			ResourceGroupName:  pulumi.String("sbz_demo"),
			Tags:               pulumi.StringMap{},
			VolumeResourceName: pulumi.String("sampleVolume"),
		})
		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.servicefabricmesh.Volume;
import com.pulumi.azurenative.servicefabricmesh.VolumeArgs;
import com.pulumi.azurenative.servicefabricmesh.inputs.VolumeProviderParametersAzureFileArgs;
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()
            .azureFileParameters(VolumeProviderParametersAzureFileArgs.builder()
                .accountKey("provide-account-key-here")
                .accountName("sbzdemoaccount")
                .shareName("sharel")
                .build())
            .description("Service Fabric Mesh sample volume.")
            .location("EastUS")
            .provider("SFAzureFile")
            .resourceGroupName("sbz_demo")
            .tags()
            .volumeResourceName("sampleVolume")
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const volume = new azure_native.servicefabricmesh.Volume("volume", {
    azureFileParameters: {
        accountKey: "provide-account-key-here",
        accountName: "sbzdemoaccount",
        shareName: "sharel",
    },
    description: "Service Fabric Mesh sample volume.",
    location: "EastUS",
    provider: azure_native.servicefabricmesh.VolumeProvider.SFAzureFile,
    resourceGroupName: "sbz_demo",
    tags: {},
    volumeResourceName: "sampleVolume",
});
import pulumi
import pulumi_azure_native as azure_native
volume = azure_native.servicefabricmesh.Volume("volume",
    azure_file_parameters={
        "account_key": "provide-account-key-here",
        "account_name": "sbzdemoaccount",
        "share_name": "sharel",
    },
    description="Service Fabric Mesh sample volume.",
    location="EastUS",
    provider=azure_native.servicefabricmesh.VolumeProvider.SF_AZURE_FILE,
    resource_group_name="sbz_demo",
    tags={},
    volume_resource_name="sampleVolume")
resources:
  volume:
    type: azure-native:servicefabricmesh:Volume
    properties:
      azureFileParameters:
        accountKey: provide-account-key-here
        accountName: sbzdemoaccount
        shareName: sharel
      description: Service Fabric Mesh sample volume.
      location: EastUS
      provider: SFAzureFile
      resourceGroupName: sbz_demo
      tags: {}
      volumeResourceName: sampleVolume
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,
           provider: Optional[Union[str, VolumeProvider]] = None,
           resource_group_name: Optional[str] = None,
           azure_file_parameters: Optional[VolumeProviderParametersAzureFileArgs] = None,
           description: Optional[str] = None,
           location: Optional[str] = None,
           tags: Optional[Mapping[str, str]] = None,
           volume_resource_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:servicefabricmesh: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 examplevolumeResourceResourceFromServicefabricmesh = new AzureNative.ServiceFabricMesh.Volume("examplevolumeResourceResourceFromServicefabricmesh", new()
{
    Provider = "string",
    ResourceGroupName = "string",
    AzureFileParameters = new AzureNative.ServiceFabricMesh.Inputs.VolumeProviderParametersAzureFileArgs
    {
        AccountName = "string",
        ShareName = "string",
        AccountKey = "string",
    },
    Description = "string",
    Location = "string",
    Tags = 
    {
        { "string", "string" },
    },
    VolumeResourceName = "string",
});
example, err := servicefabricmesh.NewVolume(ctx, "examplevolumeResourceResourceFromServicefabricmesh", &servicefabricmesh.VolumeArgs{
	Provider:          pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	AzureFileParameters: &servicefabricmesh.VolumeProviderParametersAzureFileArgs{
		AccountName: pulumi.String("string"),
		ShareName:   pulumi.String("string"),
		AccountKey:  pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Location:    pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VolumeResourceName: pulumi.String("string"),
})
var examplevolumeResourceResourceFromServicefabricmesh = new Volume("examplevolumeResourceResourceFromServicefabricmesh", VolumeArgs.builder()
    .provider("string")
    .resourceGroupName("string")
    .azureFileParameters(VolumeProviderParametersAzureFileArgs.builder()
        .accountName("string")
        .shareName("string")
        .accountKey("string")
        .build())
    .description("string")
    .location("string")
    .tags(Map.of("string", "string"))
    .volumeResourceName("string")
    .build());
examplevolume_resource_resource_from_servicefabricmesh = azure_native.servicefabricmesh.Volume("examplevolumeResourceResourceFromServicefabricmesh",
    provider="string",
    resource_group_name="string",
    azure_file_parameters={
        "account_name": "string",
        "share_name": "string",
        "account_key": "string",
    },
    description="string",
    location="string",
    tags={
        "string": "string",
    },
    volume_resource_name="string")
const examplevolumeResourceResourceFromServicefabricmesh = new azure_native.servicefabricmesh.Volume("examplevolumeResourceResourceFromServicefabricmesh", {
    provider: "string",
    resourceGroupName: "string",
    azureFileParameters: {
        accountName: "string",
        shareName: "string",
        accountKey: "string",
    },
    description: "string",
    location: "string",
    tags: {
        string: "string",
    },
    volumeResourceName: "string",
});
type: azure-native:servicefabricmesh:Volume
properties:
    azureFileParameters:
        accountKey: string
        accountName: string
        shareName: string
    description: string
    location: string
    provider: string
    resourceGroupName: string
    tags:
        string: string
    volumeResourceName: 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:
- Provider
string | Pulumi.Azure Native. Service Fabric Mesh. Volume Provider 
- Provider of the volume.
- ResourceGroup stringName 
- Azure resource group name
- AzureFile Pulumi.Parameters Azure Native. Service Fabric Mesh. Inputs. Volume Provider Parameters Azure File 
- This type describes a volume provided by an Azure Files file share.
- Description string
- User readable description of the volume.
- Location string
- The geo-location where the resource lives
- Dictionary<string, string>
- Resource tags.
- VolumeResource stringName 
- The identity of the volume.
- Provider
string | VolumeProvider 
- Provider of the volume.
- ResourceGroup stringName 
- Azure resource group name
- AzureFile VolumeParameters Provider Parameters Azure File Args 
- This type describes a volume provided by an Azure Files file share.
- Description string
- User readable description of the volume.
- Location string
- The geo-location where the resource lives
- map[string]string
- Resource tags.
- VolumeResource stringName 
- The identity of the volume.
- provider
String | VolumeProvider 
- Provider of the volume.
- resourceGroup StringName 
- Azure resource group name
- azureFile VolumeParameters Provider Parameters Azure File 
- This type describes a volume provided by an Azure Files file share.
- description String
- User readable description of the volume.
- location String
- The geo-location where the resource lives
- Map<String,String>
- Resource tags.
- volumeResource StringName 
- The identity of the volume.
- provider
string | VolumeProvider 
- Provider of the volume.
- resourceGroup stringName 
- Azure resource group name
- azureFile VolumeParameters Provider Parameters Azure File 
- This type describes a volume provided by an Azure Files file share.
- description string
- User readable description of the volume.
- location string
- The geo-location where the resource lives
- {[key: string]: string}
- Resource tags.
- volumeResource stringName 
- The identity of the volume.
- provider
str | VolumeProvider 
- Provider of the volume.
- resource_group_ strname 
- Azure resource group name
- azure_file_ Volumeparameters Provider Parameters Azure File Args 
- This type describes a volume provided by an Azure Files file share.
- description str
- User readable description of the volume.
- location str
- The geo-location where the resource lives
- Mapping[str, str]
- Resource tags.
- volume_resource_ strname 
- The identity of the volume.
- provider
String | "SFAzureFile" 
- Provider of the volume.
- resourceGroup StringName 
- Azure resource group name
- azureFile Property MapParameters 
- This type describes a volume provided by an Azure Files file share.
- description String
- User readable description of the volume.
- location String
- The geo-location where the resource lives
- Map<String>
- Resource tags.
- volumeResource StringName 
- The identity of the volume.
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
- State of the resource.
- Status string
- Status of the volume.
- StatusDetails string
- Gives additional information about the current status of the volume.
- Type string
- The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- ProvisioningState string
- State of the resource.
- Status string
- Status of the volume.
- StatusDetails string
- Gives additional information about the current status of the volume.
- Type string
- The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- provisioningState String
- State of the resource.
- status String
- Status of the volume.
- statusDetails String
- Gives additional information about the current status of the volume.
- type String
- The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- provisioningState string
- State of the resource.
- status string
- Status of the volume.
- statusDetails string
- Gives additional information about the current status of the volume.
- type string
- The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- provisioning_state str
- State of the resource.
- status str
- Status of the volume.
- status_details str
- Gives additional information about the current status of the volume.
- type str
- The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- provisioningState String
- State of the resource.
- status String
- Status of the volume.
- statusDetails String
- Gives additional information about the current status of the volume.
- type String
- The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
Supporting Types
VolumeProvider, VolumeProviderArgs    
- SFAzureFile 
- SFAzureFileProvides volumes that are backed by Azure Files.
- VolumeProvider SFAzure File 
- SFAzureFileProvides volumes that are backed by Azure Files.
- SFAzureFile 
- SFAzureFileProvides volumes that are backed by Azure Files.
- SFAzureFile 
- SFAzureFileProvides volumes that are backed by Azure Files.
- SF_AZURE_FILE
- SFAzureFileProvides volumes that are backed by Azure Files.
- "SFAzureFile" 
- SFAzureFileProvides volumes that are backed by Azure Files.
VolumeProviderParametersAzureFile, VolumeProviderParametersAzureFileArgs          
- AccountName string
- Name of the Azure storage account for the File Share.
- string
- Name of the Azure Files file share that provides storage for the volume.
- AccountKey string
- Access key of the Azure storage account for the File Share.
- AccountName string
- Name of the Azure storage account for the File Share.
- string
- Name of the Azure Files file share that provides storage for the volume.
- AccountKey string
- Access key of the Azure storage account for the File Share.
- accountName String
- Name of the Azure storage account for the File Share.
- String
- Name of the Azure Files file share that provides storage for the volume.
- accountKey String
- Access key of the Azure storage account for the File Share.
- accountName string
- Name of the Azure storage account for the File Share.
- string
- Name of the Azure Files file share that provides storage for the volume.
- accountKey string
- Access key of the Azure storage account for the File Share.
- account_name str
- Name of the Azure storage account for the File Share.
- str
- Name of the Azure Files file share that provides storage for the volume.
- account_key str
- Access key of the Azure storage account for the File Share.
- accountName String
- Name of the Azure storage account for the File Share.
- String
- Name of the Azure Files file share that provides storage for the volume.
- accountKey String
- Access key of the Azure storage account for the File Share.
VolumeProviderParametersAzureFileResponse, VolumeProviderParametersAzureFileResponseArgs            
- AccountName string
- Name of the Azure storage account for the File Share.
- string
- Name of the Azure Files file share that provides storage for the volume.
- AccountKey string
- Access key of the Azure storage account for the File Share.
- AccountName string
- Name of the Azure storage account for the File Share.
- string
- Name of the Azure Files file share that provides storage for the volume.
- AccountKey string
- Access key of the Azure storage account for the File Share.
- accountName String
- Name of the Azure storage account for the File Share.
- String
- Name of the Azure Files file share that provides storage for the volume.
- accountKey String
- Access key of the Azure storage account for the File Share.
- accountName string
- Name of the Azure storage account for the File Share.
- string
- Name of the Azure Files file share that provides storage for the volume.
- accountKey string
- Access key of the Azure storage account for the File Share.
- account_name str
- Name of the Azure storage account for the File Share.
- str
- Name of the Azure Files file share that provides storage for the volume.
- account_key str
- Access key of the Azure storage account for the File Share.
- accountName String
- Name of the Azure storage account for the File Share.
- String
- Name of the Azure Files file share that provides storage for the volume.
- accountKey String
- Access key of the Azure storage account for the File Share.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:servicefabricmesh:Volume sampleVolume /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes/{volumeResourceName} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0