1. Packages
  2. Azure Native
  3. API Docs
  4. fileshares
  5. getFileShareSnapshot
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

    Get a FileShareSnapshot

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

    Using getFileShareSnapshot

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFileShareSnapshot(args: GetFileShareSnapshotArgs, opts?: InvokeOptions): Promise<GetFileShareSnapshotResult>
    function getFileShareSnapshotOutput(args: GetFileShareSnapshotOutputArgs, opts?: InvokeOptions): Output<GetFileShareSnapshotResult>
    def get_file_share_snapshot(name: Optional[str] = None,
                                resource_group_name: Optional[str] = None,
                                resource_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetFileShareSnapshotResult
    def get_file_share_snapshot_output(name: Optional[pulumi.Input[str]] = None,
                                resource_group_name: Optional[pulumi.Input[str]] = None,
                                resource_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetFileShareSnapshotResult]
    func LookupFileShareSnapshot(ctx *Context, args *LookupFileShareSnapshotArgs, opts ...InvokeOption) (*LookupFileShareSnapshotResult, error)
    func LookupFileShareSnapshotOutput(ctx *Context, args *LookupFileShareSnapshotOutputArgs, opts ...InvokeOption) LookupFileShareSnapshotResultOutput

    > Note: This function is named LookupFileShareSnapshot in the Go SDK.

    public static class GetFileShareSnapshot 
    {
        public static Task<GetFileShareSnapshotResult> InvokeAsync(GetFileShareSnapshotArgs args, InvokeOptions? opts = null)
        public static Output<GetFileShareSnapshotResult> Invoke(GetFileShareSnapshotInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFileShareSnapshotResult> getFileShareSnapshot(GetFileShareSnapshotArgs args, InvokeOptions options)
    public static Output<GetFileShareSnapshotResult> getFileShareSnapshot(GetFileShareSnapshotArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:fileshares:getFileShareSnapshot
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the FileShareSnapshot
    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
    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
    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
    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 str
    The name of the FileShareSnapshot
    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 String
    The name of the FileShareSnapshot
    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.

    getFileShareSnapshot Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.FileShares.Outputs.FileShareSnapshotPropertiesResponse
    The resource-specific properties for this 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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties FileShareSnapshotPropertiesResponse
    The resource-specific properties for this 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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties FileShareSnapshotPropertiesResponse
    The resource-specific properties for this 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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    properties FileShareSnapshotPropertiesResponse
    The resource-specific properties for this 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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    properties FileShareSnapshotPropertiesResponse
    The resource-specific properties for this 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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties Property Map
    The resource-specific properties for this 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

    FileShareSnapshotPropertiesResponse

    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

    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.

    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.