1. Packages
  2. Azure Native
  3. API Docs
  4. fileshares
  5. FileShareSnapshot
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.15.0
published on Wednesday, Mar 4, 2026 by Pulumi
azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.15.0
published on Wednesday, Mar 4, 2026 by Pulumi

    FileShareSnapshot resource

    Uses Azure REST API version 2025-06-01-preview.

    Example Usage

    FileShareSnapshot_CreateOrUpdate_MaximumSet

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var fileShareSnapshot = new AzureNative.FileShares.FileShareSnapshot("fileShareSnapshot", new()
        {
            Name = "testfilesharesnapshot",
            Properties = new AzureNative.FileShares.Inputs.FileShareSnapshotPropertiesArgs
            {
                Metadata = 
                {
                    { "key9372", "jtc" },
                },
            },
            ResourceGroupName = "rgfileshares",
            ResourceName = "fileshare",
        });
    
    });
    
    package main
    
    import (
    	fileshares "github.com/pulumi/pulumi-azure-native-sdk/fileshares/v3"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := fileshares.NewFileShareSnapshot(ctx, "fileShareSnapshot", &fileshares.FileShareSnapshotArgs{
    			Name: pulumi.String("testfilesharesnapshot"),
    			Properties: &fileshares.FileShareSnapshotPropertiesArgs{
    				Metadata: pulumi.StringMap{
    					"key9372": pulumi.String("jtc"),
    				},
    			},
    			ResourceGroupName: pulumi.String("rgfileshares"),
    			ResourceName:      pulumi.String("fileshare"),
    		})
    		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.fileshares.FileShareSnapshot;
    import com.pulumi.azurenative.fileshares.FileShareSnapshotArgs;
    import com.pulumi.azurenative.fileshares.inputs.FileShareSnapshotPropertiesArgs;
    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 fileShareSnapshot = new FileShareSnapshot("fileShareSnapshot", FileShareSnapshotArgs.builder()
                .name("testfilesharesnapshot")
                .properties(FileShareSnapshotPropertiesArgs.builder()
                    .metadata(Map.of("key9372", "jtc"))
                    .build())
                .resourceGroupName("rgfileshares")
                .resourceName("fileshare")
                .build());
    
        }
    }
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const fileShareSnapshot = new azure_native.fileshares.FileShareSnapshot("fileShareSnapshot", {
        name: "testfilesharesnapshot",
        properties: {
            metadata: {
                key9372: "jtc",
            },
        },
        resourceGroupName: "rgfileshares",
        resourceName: "fileshare",
    });
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    file_share_snapshot = azure_native.fileshares.FileShareSnapshot("fileShareSnapshot",
        name="testfilesharesnapshot",
        properties={
            "metadata": {
                "key9372": "jtc",
            },
        },
        resource_group_name="rgfileshares",
        resource_name_="fileshare")
    
    resources:
      fileShareSnapshot:
        type: azure-native:fileshares:FileShareSnapshot
        properties:
          name: testfilesharesnapshot
          properties:
            metadata:
              key9372: jtc
          resourceGroupName: rgfileshares
          resourceName: fileshare
    

    Create FileShareSnapshot Resource

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

    Constructor syntax

    new FileShareSnapshot(name: string, args: FileShareSnapshotArgs, opts?: CustomResourceOptions);
    @overload
    def FileShareSnapshot(resource_name: str,
                          args: FileShareSnapshotArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def FileShareSnapshot(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          resource_group_name: Optional[str] = None,
                          resource_name_: Optional[str] = None,
                          name: Optional[str] = None,
                          properties: Optional[FileShareSnapshotPropertiesArgs] = None)
    func NewFileShareSnapshot(ctx *Context, name string, args FileShareSnapshotArgs, opts ...ResourceOption) (*FileShareSnapshot, error)
    public FileShareSnapshot(string name, FileShareSnapshotArgs args, CustomResourceOptions? opts = null)
    public FileShareSnapshot(String name, FileShareSnapshotArgs args)
    public FileShareSnapshot(String name, FileShareSnapshotArgs args, CustomResourceOptions options)
    
    type: azure-native:fileshares:FileShareSnapshot
    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 FileShareSnapshotArgs
    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 FileShareSnapshotArgs
    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 FileShareSnapshotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FileShareSnapshotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FileShareSnapshotArgs
    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 fileShareSnapshotResource = new AzureNative.FileShares.FileShareSnapshot("fileShareSnapshotResource", new()
    {
        ResourceGroupName = "string",
        ResourceName = "string",
        Name = "string",
        Properties = new AzureNative.FileShares.Inputs.FileShareSnapshotPropertiesArgs
        {
            Metadata = 
            {
                { "string", "string" },
            },
        },
    });
    
    example, err := fileshares.NewFileShareSnapshot(ctx, "fileShareSnapshotResource", &fileshares.FileShareSnapshotArgs{
    	ResourceGroupName: pulumi.String("string"),
    	ResourceName:      pulumi.String("string"),
    	Name:              pulumi.String("string"),
    	Properties: &fileshares.FileShareSnapshotPropertiesArgs{
    		Metadata: pulumi.StringMap{
    			"string": pulumi.String("string"),
    		},
    	},
    })
    
    var fileShareSnapshotResource = new FileShareSnapshot("fileShareSnapshotResource", FileShareSnapshotArgs.builder()
        .resourceGroupName("string")
        .resourceName("string")
        .name("string")
        .properties(FileShareSnapshotPropertiesArgs.builder()
            .metadata(Map.of("string", "string"))
            .build())
        .build());
    
    file_share_snapshot_resource = azure_native.fileshares.FileShareSnapshot("fileShareSnapshotResource",
        resource_group_name="string",
        resource_name_="string",
        name="string",
        properties={
            "metadata": {
                "string": "string",
            },
        })
    
    const fileShareSnapshotResource = new azure_native.fileshares.FileShareSnapshot("fileShareSnapshotResource", {
        resourceGroupName: "string",
        resourceName: "string",
        name: "string",
        properties: {
            metadata: {
                string: "string",
            },
        },
    });
    
    type: azure-native:fileshares:FileShareSnapshot
    properties:
        name: string
        properties:
            metadata:
                string: string
        resourceGroupName: string
        resourceName: string
    

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

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ResourceName string
    The resource name of the file share, as seen by the administrator through Azure Resource Manager.
    Name string
    The name of the FileShareSnapshot
    Properties Pulumi.AzureNative.FileShares.Inputs.FileShareSnapshotProperties
    The resource-specific properties for this resource.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ResourceName string
    The resource name of the file share, as seen by the administrator through Azure Resource Manager.
    Name string
    The name of the FileShareSnapshot
    Properties FileShareSnapshotPropertiesArgs
    The resource-specific properties for this resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    resourceName String
    The resource name of the file share, as seen by the administrator through Azure Resource Manager.
    name String
    The name of the FileShareSnapshot
    properties FileShareSnapshotProperties
    The resource-specific properties for this resource.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    resourceName string
    The resource name of the file share, as seen by the administrator through Azure Resource Manager.
    name string
    The name of the FileShareSnapshot
    properties FileShareSnapshotProperties
    The resource-specific properties for this resource.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    resource_name str
    The resource name of the file share, as seen by the administrator through Azure Resource Manager.
    name str
    The name of the FileShareSnapshot
    properties FileShareSnapshotPropertiesArgs
    The resource-specific properties for this resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    resourceName String
    The resource name of the file share, as seen by the administrator through Azure Resource Manager.
    name String
    The name of the FileShareSnapshot
    properties Property Map
    The resource-specific properties for this resource.

    Outputs

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

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    SystemData Pulumi.AzureNative.FileShares.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"
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed 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"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed 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"
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The provider-assigned unique ID for this managed 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"
    azure_api_version str
    The Azure API version of the resource.
    id str
    The provider-assigned unique ID for this managed 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"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed 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"

    Supporting Types

    FileShareSnapshotProperties, FileShareSnapshotPropertiesArgs

    FileShareSnapshot properties
    Metadata Dictionary<string, string>
    The metadata
    Metadata map[string]string
    The metadata
    metadata Map<String,String>
    The metadata
    metadata {[key: string]: string}
    The metadata
    metadata Mapping[str, str]
    The metadata
    metadata Map<String>
    The metadata

    FileShareSnapshotPropertiesResponse, FileShareSnapshotPropertiesResponseArgs

    FileShareSnapshot properties
    InitiatorId string
    The initiator of the FileShareSnapshot. This is a user-defined value.
    SnapshotTime string
    The FileShareSnapshot time in UTC in string representation
    Metadata Dictionary<string, string>
    The metadata
    InitiatorId string
    The initiator of the FileShareSnapshot. This is a user-defined value.
    SnapshotTime string
    The FileShareSnapshot time in UTC in string representation
    Metadata map[string]string
    The metadata
    initiatorId String
    The initiator of the FileShareSnapshot. This is a user-defined value.
    snapshotTime String
    The FileShareSnapshot time in UTC in string representation
    metadata Map<String,String>
    The metadata
    initiatorId string
    The initiator of the FileShareSnapshot. This is a user-defined value.
    snapshotTime string
    The FileShareSnapshot time in UTC in string representation
    metadata {[key: string]: string}
    The metadata
    initiator_id str
    The initiator of the FileShareSnapshot. This is a user-defined value.
    snapshot_time str
    The FileShareSnapshot time in UTC in string representation
    metadata Mapping[str, str]
    The metadata
    initiatorId String
    The initiator of the FileShareSnapshot. This is a user-defined value.
    snapshotTime String
    The FileShareSnapshot time in UTC in string representation
    metadata Map<String>
    The metadata

    SystemDataResponse, SystemDataResponseArgs

    Metadata pertaining to creation and last modification of 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.
    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:fileshares:FileShareSnapshot myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.FileShares/fileShares/{resourceName}/fileShareSnapshots/{name} 
    

    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 v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.15.0
    published on Wednesday, Mar 4, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.