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

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.backup.getPolicyFileshare

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const policy = azure.backup.getPolicyFileshare({
    name: "policy",
    recoveryVaultName: "recovery_vault",
    resourceGroupName: "resource_group",
});
Copy
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")
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/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
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var policy = Azure.Backup.GetPolicyFileshare.Invoke(new()
    {
        Name = "policy",
        RecoveryVaultName = "recovery_vault",
        ResourceGroupName = "resource_group",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.backup.BackupFunctions;
import com.pulumi.azure.backup.inputs.GetPolicyFileshareArgs;
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) {
        final var policy = BackupFunctions.getPolicyFileshare(GetPolicyFileshareArgs.builder()
            .name("policy")
            .recoveryVaultName("recovery_vault")
            .resourceGroupName("resource_group")
            .build());

    }
}
Copy
variables:
  policy:
    fn::invoke:
      function: azure:backup:getPolicyFileshare
      arguments:
        name: policy
        recoveryVaultName: recovery_vault
        resourceGroupName: resource_group
Copy

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>
Copy
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]
Copy
func GetPolicyFileshare(ctx *Context, args *GetPolicyFileshareArgs, opts ...InvokeOption) (*GetPolicyFileshareResult, error)
func GetPolicyFileshareOutput(ctx *Context, args *GetPolicyFileshareOutputArgs, opts ...InvokeOption) GetPolicyFileshareResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetPolicyFileshareResult> getPolicyFileshare(GetPolicyFileshareArgs args, InvokeOptions options)
public static Output<GetPolicyFileshareResult> getPolicyFileshare(GetPolicyFileshareArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure:backup/getPolicyFileshare:getPolicyFileshare
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Specifies the name of the File Share Backup Policy.
RecoveryVaultName This property is required. string
Specifies the name of the Recovery Services Vault.
ResourceGroupName This property is required. string
The name of the resource group in which the File Share Backup Policy resides.
Name This property is required. string
Specifies the name of the File Share Backup Policy.
RecoveryVaultName This property is required. string
Specifies the name of the Recovery Services Vault.
ResourceGroupName This property is required. string
The name of the resource group in which the File Share Backup Policy resides.
name This property is required. String
Specifies the name of the File Share Backup Policy.
recoveryVaultName This property is required. String
Specifies the name of the Recovery Services Vault.
resourceGroupName This property is required. String
The name of the resource group in which the File Share Backup Policy resides.
name This property is required. string
Specifies the name of the File Share Backup Policy.
recoveryVaultName This property is required. string
Specifies the name of the Recovery Services Vault.
resourceGroupName This property is required. string
The name of the resource group in which the File Share Backup Policy resides.
name This property is required. str
Specifies the name of the File Share Backup Policy.
recovery_vault_name This property is required. str
Specifies the name of the Recovery Services Vault.
resource_group_name This property is required. str
The name of the resource group in which the File Share Backup Policy resides.
name This property is required. String
Specifies the name of the File Share Backup Policy.
recoveryVaultName This property is required. String
Specifies the name of the Recovery Services Vault.
resourceGroupName This property is required. 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
Id string
The provider-assigned unique ID for this managed resource.
Name string
RecoveryVaultName string
ResourceGroupName string
id String
The provider-assigned unique ID for this managed resource.
name String
recoveryVaultName String
resourceGroupName String
id string
The provider-assigned unique ID for this managed resource.
name string
recoveryVaultName string
resourceGroupName string
id str
The provider-assigned unique ID for this managed resource.
name str
recovery_vault_name str
resource_group_name str
id String
The provider-assigned unique ID for this managed resource.
name String
recoveryVaultName String
resourceGroupName String

Package Details

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

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi