Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. netapp
  5. getSnapshotPolicy
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.netapp.getSnapshotPolicy

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a snapshot Policy

Uses Azure REST API version 2024-09-01.

Other available API versions: 2022-11-01, 2022-11-01-preview, 2023-05-01, 2023-05-01-preview, 2023-07-01, 2023-07-01-preview, 2023-11-01, 2023-11-01-preview, 2024-01-01, 2024-03-01, 2024-03-01-preview, 2024-05-01, 2024-05-01-preview, 2024-07-01, 2024-07-01-preview, 2024-09-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native netapp [ApiVersion]. See the version guide for details.

Using getSnapshotPolicy

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 getSnapshotPolicy(args: GetSnapshotPolicyArgs, opts?: InvokeOptions): Promise<GetSnapshotPolicyResult>
function getSnapshotPolicyOutput(args: GetSnapshotPolicyOutputArgs, opts?: InvokeOptions): Output<GetSnapshotPolicyResult>
Copy
def get_snapshot_policy(account_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        snapshot_policy_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetSnapshotPolicyResult
def get_snapshot_policy_output(account_name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        snapshot_policy_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetSnapshotPolicyResult]
Copy
func LookupSnapshotPolicy(ctx *Context, args *LookupSnapshotPolicyArgs, opts ...InvokeOption) (*LookupSnapshotPolicyResult, error)
func LookupSnapshotPolicyOutput(ctx *Context, args *LookupSnapshotPolicyOutputArgs, opts ...InvokeOption) LookupSnapshotPolicyResultOutput
Copy

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

public static class GetSnapshotPolicy 
{
    public static Task<GetSnapshotPolicyResult> InvokeAsync(GetSnapshotPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetSnapshotPolicyResult> Invoke(GetSnapshotPolicyInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSnapshotPolicyResult> getSnapshotPolicy(GetSnapshotPolicyArgs args, InvokeOptions options)
public static Output<GetSnapshotPolicyResult> getSnapshotPolicy(GetSnapshotPolicyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:netapp:getSnapshotPolicy
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the NetApp account
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SnapshotPolicyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the snapshot policy
AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the NetApp account
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SnapshotPolicyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the snapshot policy
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the NetApp account
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
snapshotPolicyName
This property is required.
Changes to this property will trigger replacement.
String
The name of the snapshot policy
accountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the NetApp account
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
snapshotPolicyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the snapshot policy
account_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the NetApp account
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
snapshot_policy_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the snapshot policy
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the NetApp account
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
snapshotPolicyName
This property is required.
Changes to this property will trigger replacement.
String
The name of the snapshot policy

getSnapshotPolicy Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
Azure lifecycle management
SystemData Pulumi.AzureNative.NetApp.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"
DailySchedule Pulumi.AzureNative.NetApp.Outputs.DailyScheduleResponse
Schedule for daily snapshots
Enabled bool
The property to decide policy is enabled or not
HourlySchedule Pulumi.AzureNative.NetApp.Outputs.HourlyScheduleResponse
Schedule for hourly snapshots
MonthlySchedule Pulumi.AzureNative.NetApp.Outputs.MonthlyScheduleResponse
Schedule for monthly snapshots
Tags Dictionary<string, string>
Resource tags.
WeeklySchedule Pulumi.AzureNative.NetApp.Outputs.WeeklyScheduleResponse
Schedule for weekly snapshots
AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
Azure lifecycle management
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"
DailySchedule DailyScheduleResponse
Schedule for daily snapshots
Enabled bool
The property to decide policy is enabled or not
HourlySchedule HourlyScheduleResponse
Schedule for hourly snapshots
MonthlySchedule MonthlyScheduleResponse
Schedule for monthly snapshots
Tags map[string]string
Resource tags.
WeeklySchedule WeeklyScheduleResponse
Schedule for weekly snapshots
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
Azure lifecycle management
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"
dailySchedule DailyScheduleResponse
Schedule for daily snapshots
enabled Boolean
The property to decide policy is enabled or not
hourlySchedule HourlyScheduleResponse
Schedule for hourly snapshots
monthlySchedule MonthlyScheduleResponse
Schedule for monthly snapshots
tags Map<String,String>
Resource tags.
weeklySchedule WeeklyScheduleResponse
Schedule for weekly snapshots
azureApiVersion string
The Azure API version of the resource.
etag string
A unique read-only string that changes whenever the resource is updated.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location string
The geo-location where the resource lives
name string
The name of the resource
provisioningState string
Azure lifecycle management
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"
dailySchedule DailyScheduleResponse
Schedule for daily snapshots
enabled boolean
The property to decide policy is enabled or not
hourlySchedule HourlyScheduleResponse
Schedule for hourly snapshots
monthlySchedule MonthlyScheduleResponse
Schedule for monthly snapshots
tags {[key: string]: string}
Resource tags.
weeklySchedule WeeklyScheduleResponse
Schedule for weekly snapshots
azure_api_version str
The Azure API version of the resource.
etag str
A unique read-only string that changes whenever the resource is updated.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location str
The geo-location where the resource lives
name str
The name of the resource
provisioning_state str
Azure lifecycle management
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"
daily_schedule DailyScheduleResponse
Schedule for daily snapshots
enabled bool
The property to decide policy is enabled or not
hourly_schedule HourlyScheduleResponse
Schedule for hourly snapshots
monthly_schedule MonthlyScheduleResponse
Schedule for monthly snapshots
tags Mapping[str, str]
Resource tags.
weekly_schedule WeeklyScheduleResponse
Schedule for weekly snapshots
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
Azure lifecycle management
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"
dailySchedule Property Map
Schedule for daily snapshots
enabled Boolean
The property to decide policy is enabled or not
hourlySchedule Property Map
Schedule for hourly snapshots
monthlySchedule Property Map
Schedule for monthly snapshots
tags Map<String>
Resource tags.
weeklySchedule Property Map
Schedule for weekly snapshots

Supporting Types

DailyScheduleResponse

Hour int
Indicates which hour in UTC timezone a snapshot should be taken
Minute int
Indicates which minute snapshot should be taken
SnapshotsToKeep int
Daily snapshot count to keep
UsedBytes double
Resource size in bytes, current storage usage for the volume in bytes
Hour int
Indicates which hour in UTC timezone a snapshot should be taken
Minute int
Indicates which minute snapshot should be taken
SnapshotsToKeep int
Daily snapshot count to keep
UsedBytes float64
Resource size in bytes, current storage usage for the volume in bytes
hour Integer
Indicates which hour in UTC timezone a snapshot should be taken
minute Integer
Indicates which minute snapshot should be taken
snapshotsToKeep Integer
Daily snapshot count to keep
usedBytes Double
Resource size in bytes, current storage usage for the volume in bytes
hour number
Indicates which hour in UTC timezone a snapshot should be taken
minute number
Indicates which minute snapshot should be taken
snapshotsToKeep number
Daily snapshot count to keep
usedBytes number
Resource size in bytes, current storage usage for the volume in bytes
hour int
Indicates which hour in UTC timezone a snapshot should be taken
minute int
Indicates which minute snapshot should be taken
snapshots_to_keep int
Daily snapshot count to keep
used_bytes float
Resource size in bytes, current storage usage for the volume in bytes
hour Number
Indicates which hour in UTC timezone a snapshot should be taken
minute Number
Indicates which minute snapshot should be taken
snapshotsToKeep Number
Daily snapshot count to keep
usedBytes Number
Resource size in bytes, current storage usage for the volume in bytes

HourlyScheduleResponse

Minute int
Indicates which minute snapshot should be taken
SnapshotsToKeep int
Hourly snapshot count to keep
UsedBytes double
Resource size in bytes, current storage usage for the volume in bytes
Minute int
Indicates which minute snapshot should be taken
SnapshotsToKeep int
Hourly snapshot count to keep
UsedBytes float64
Resource size in bytes, current storage usage for the volume in bytes
minute Integer
Indicates which minute snapshot should be taken
snapshotsToKeep Integer
Hourly snapshot count to keep
usedBytes Double
Resource size in bytes, current storage usage for the volume in bytes
minute number
Indicates which minute snapshot should be taken
snapshotsToKeep number
Hourly snapshot count to keep
usedBytes number
Resource size in bytes, current storage usage for the volume in bytes
minute int
Indicates which minute snapshot should be taken
snapshots_to_keep int
Hourly snapshot count to keep
used_bytes float
Resource size in bytes, current storage usage for the volume in bytes
minute Number
Indicates which minute snapshot should be taken
snapshotsToKeep Number
Hourly snapshot count to keep
usedBytes Number
Resource size in bytes, current storage usage for the volume in bytes

MonthlyScheduleResponse

DaysOfMonth string
Indicates which days of the month snapshot should be taken. A comma delimited string.
Hour int
Indicates which hour in UTC timezone a snapshot should be taken
Minute int
Indicates which minute snapshot should be taken
SnapshotsToKeep int
Monthly snapshot count to keep
UsedBytes double
Resource size in bytes, current storage usage for the volume in bytes
DaysOfMonth string
Indicates which days of the month snapshot should be taken. A comma delimited string.
Hour int
Indicates which hour in UTC timezone a snapshot should be taken
Minute int
Indicates which minute snapshot should be taken
SnapshotsToKeep int
Monthly snapshot count to keep
UsedBytes float64
Resource size in bytes, current storage usage for the volume in bytes
daysOfMonth String
Indicates which days of the month snapshot should be taken. A comma delimited string.
hour Integer
Indicates which hour in UTC timezone a snapshot should be taken
minute Integer
Indicates which minute snapshot should be taken
snapshotsToKeep Integer
Monthly snapshot count to keep
usedBytes Double
Resource size in bytes, current storage usage for the volume in bytes
daysOfMonth string
Indicates which days of the month snapshot should be taken. A comma delimited string.
hour number
Indicates which hour in UTC timezone a snapshot should be taken
minute number
Indicates which minute snapshot should be taken
snapshotsToKeep number
Monthly snapshot count to keep
usedBytes number
Resource size in bytes, current storage usage for the volume in bytes
days_of_month str
Indicates which days of the month snapshot should be taken. A comma delimited string.
hour int
Indicates which hour in UTC timezone a snapshot should be taken
minute int
Indicates which minute snapshot should be taken
snapshots_to_keep int
Monthly snapshot count to keep
used_bytes float
Resource size in bytes, current storage usage for the volume in bytes
daysOfMonth String
Indicates which days of the month snapshot should be taken. A comma delimited string.
hour Number
Indicates which hour in UTC timezone a snapshot should be taken
minute Number
Indicates which minute snapshot should be taken
snapshotsToKeep Number
Monthly snapshot count to keep
usedBytes Number
Resource size in bytes, current storage usage for the volume in bytes

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.

WeeklyScheduleResponse

Day string
Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english
Hour int
Indicates which hour in UTC timezone a snapshot should be taken
Minute int
Indicates which minute snapshot should be taken
SnapshotsToKeep int
Weekly snapshot count to keep
UsedBytes double
Resource size in bytes, current storage usage for the volume in bytes
Day string
Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english
Hour int
Indicates which hour in UTC timezone a snapshot should be taken
Minute int
Indicates which minute snapshot should be taken
SnapshotsToKeep int
Weekly snapshot count to keep
UsedBytes float64
Resource size in bytes, current storage usage for the volume in bytes
day String
Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english
hour Integer
Indicates which hour in UTC timezone a snapshot should be taken
minute Integer
Indicates which minute snapshot should be taken
snapshotsToKeep Integer
Weekly snapshot count to keep
usedBytes Double
Resource size in bytes, current storage usage for the volume in bytes
day string
Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english
hour number
Indicates which hour in UTC timezone a snapshot should be taken
minute number
Indicates which minute snapshot should be taken
snapshotsToKeep number
Weekly snapshot count to keep
usedBytes number
Resource size in bytes, current storage usage for the volume in bytes
day str
Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english
hour int
Indicates which hour in UTC timezone a snapshot should be taken
minute int
Indicates which minute snapshot should be taken
snapshots_to_keep int
Weekly snapshot count to keep
used_bytes float
Resource size in bytes, current storage usage for the volume in bytes
day String
Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english
hour Number
Indicates which hour in UTC timezone a snapshot should be taken
minute Number
Indicates which minute snapshot should be taken
snapshotsToKeep Number
Weekly snapshot count to keep
usedBytes Number
Resource size in bytes, current storage usage for the volume in bytes

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native