1. Packages
  2. Azure Classic
  3. API Docs
  4. backup
  5. getPolicyFileshare

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    Use this data source to access information about an existing File Share Backup Policy.

    Example Usage

    using Pulumi;
    using Azure = Pulumi.Azure;
    
    class MyStack : Stack
    {
        public MyStack()
        {
            var policy = Output.Create(Azure.Backup.GetPolicyFileshare.InvokeAsync(new Azure.Backup.GetPolicyFileshareArgs
            {
                Name = "policy",
                RecoveryVaultName = "recovery_vault",
                ResourceGroupName = "resource_group",
            }));
        }
    
    }
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/backup"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := backup.GetPolicyFileshare(ctx, &backup.GetPolicyFileshareArgs{
    			Name:              "policy",
    			RecoveryVaultName: "recovery_vault",
    			ResourceGroupName: "resource_group",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const policy = pulumi.output(azure.backup.getPolicyFileshare({
        name: "policy",
        recoveryVaultName: "recovery_vault",
        resourceGroupName: "resource_group",
    }));
    
    import pulumi
    import pulumi_azure as azure
    
    policy = azure.backup.get_policy_fileshare(name="policy",
        recovery_vault_name="recovery_vault",
        resource_group_name="resource_group")
    

    Example coming soon!

    Using getPolicyFileshare

    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 getPolicyFileshare(args: GetPolicyFileshareArgs, opts?: InvokeOptions): Promise<GetPolicyFileshareResult>
    function getPolicyFileshareOutput(args: GetPolicyFileshareOutputArgs, opts?: InvokeOptions): Output<GetPolicyFileshareResult>
    def get_policy_fileshare(name: Optional[str] = None,
                             recovery_vault_name: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetPolicyFileshareResult
    def get_policy_fileshare_output(name: Optional[pulumi.Input[str]] = None,
                             recovery_vault_name: Optional[pulumi.Input[str]] = None,
                             resource_group_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetPolicyFileshareResult]
    func GetPolicyFileshare(ctx *Context, args *GetPolicyFileshareArgs, opts ...InvokeOption) (*GetPolicyFileshareResult, error)
    func GetPolicyFileshareOutput(ctx *Context, args *GetPolicyFileshareOutputArgs, opts ...InvokeOption) GetPolicyFileshareResultOutput

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

    public static class GetPolicyFileshare 
    {
        public static Task<GetPolicyFileshareResult> InvokeAsync(GetPolicyFileshareArgs args, InvokeOptions? opts = null)
        public static Output<GetPolicyFileshareResult> Invoke(GetPolicyFileshareInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPolicyFileshareResult> getPolicyFileshare(GetPolicyFileshareArgs args, InvokeOptions options)
    public static Output<GetPolicyFileshareResult> getPolicyFileshare(GetPolicyFileshareArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure:backup/getPolicyFileshare:getPolicyFileshare
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Specifies the name of the File Share Backup Policy.
    RecoveryVaultName string
    Specifies the name of the Recovery Services Vault.
    ResourceGroupName string
    The name of the resource group in which the File Share Backup Policy resides.
    Name string
    Specifies the name of the File Share Backup Policy.
    RecoveryVaultName string
    Specifies the name of the Recovery Services Vault.
    ResourceGroupName string
    The name of the resource group in which the File Share Backup Policy resides.
    name String
    Specifies the name of the File Share Backup Policy.
    recoveryVaultName String
    Specifies the name of the Recovery Services Vault.
    resourceGroupName String
    The name of the resource group in which the File Share Backup Policy resides.
    name string
    Specifies the name of the File Share Backup Policy.
    recoveryVaultName string
    Specifies the name of the Recovery Services Vault.
    resourceGroupName string
    The name of the resource group in which the File Share Backup Policy resides.
    name str
    Specifies the name of the File Share Backup Policy.
    recovery_vault_name str
    Specifies the name of the Recovery Services Vault.
    resource_group_name str
    The name of the resource group in which the File Share Backup Policy resides.
    name String
    Specifies the name of the File Share Backup Policy.
    recoveryVaultName String
    Specifies the name of the Recovery Services Vault.
    resourceGroupName String
    The name of the resource group in which the File Share Backup Policy resides.

    getPolicyFileshare Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    RecoveryVaultName string
    ResourceGroupName string
    Tags Dictionary<string, string>
    A mapping of tags assigned to the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    RecoveryVaultName string
    ResourceGroupName string
    Tags map[string]string
    A mapping of tags assigned to the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    recoveryVaultName String
    resourceGroupName String
    tags Map<String,String>
    A mapping of tags assigned to the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    recoveryVaultName string
    resourceGroupName string
    tags {[key: string]: string}
    A mapping of tags assigned to the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    recovery_vault_name str
    resource_group_name str
    tags Mapping[str, str]
    A mapping of tags assigned to the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    recoveryVaultName String
    resourceGroupName String
    tags Map<String>
    A mapping of tags assigned to the resource.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.