getProtectionRule

Nutanix v0.11.0, Nov 24 25

Viewing docs for Nutanix v0.11.0
published on Monday, Nov 24, 2025 by Piers Karsenbarg

Schema (JSON)

pierskarsenbarg/pulumi-nutanix

Viewing docs for Nutanix v0.11.0
published on Monday, Nov 24, 2025 by Piers Karsenbarg

Schema (JSON)

pierskarsenbarg/pulumi-nutanix

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as nutanix from "@pierskarsenbarg/nutanix";

const protectionRuleTest = new nutanix.ProtectionRule("protection_rule_test", {
    name: "test",
    description: "test",
    orderedAvailabilityZoneLists: [{
        availabilityZoneUrl: "ab788130-0820-4d07-a1b5-b0ba4d3a42asd",
    }],
    availabilityZoneConnectivityLists: [{
        snapshotScheduleLists: [{
            recoveryPointObjectiveSecs: 3600,
            snapshotType: "CRASH_CONSISTENT",
            localSnapshotRetentionPolicy: {
                numSnapshots: 1,
            },
        }],
    }],
    categoryFilter: {
        params: [{
            name: "Environment",
            values: ["Dev"],
        }],
    },
});
const test = nutanix.getProtectionRuleOutput({
    protectionRuleId: protectionRuleTest.id,
});

import pulumi
import pulumi_nutanix as nutanix

protection_rule_test = nutanix.ProtectionRule("protection_rule_test",
    name="test",
    description="test",
    ordered_availability_zone_lists=[{
        "availability_zone_url": "ab788130-0820-4d07-a1b5-b0ba4d3a42asd",
    }],
    availability_zone_connectivity_lists=[{
        "snapshot_schedule_lists": [{
            "recovery_point_objective_secs": 3600,
            "snapshot_type": "CRASH_CONSISTENT",
            "local_snapshot_retention_policy": {
                "num_snapshots": 1,
            },
        }],
    }],
    category_filter={
        "params": [{
            "name": "Environment",
            "values": ["Dev"],
        }],
    })
test = nutanix.get_protection_rule_output(protection_rule_id=protection_rule_test.id)

package main

import (
	"github.com/pierskarsenbarg/pulumi-nutanix/sdk/go/nutanix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		protectionRuleTest, err := nutanix.NewProtectionRule(ctx, "protection_rule_test", &nutanix.ProtectionRuleArgs{
			Name:        pulumi.String("test"),
			Description: pulumi.String("test"),
			OrderedAvailabilityZoneLists: nutanix.ProtectionRuleOrderedAvailabilityZoneListArray{
				&nutanix.ProtectionRuleOrderedAvailabilityZoneListArgs{
					AvailabilityZoneUrl: pulumi.String("ab788130-0820-4d07-a1b5-b0ba4d3a42asd"),
				},
			},
			AvailabilityZoneConnectivityLists: nutanix.ProtectionRuleAvailabilityZoneConnectivityListArray{
				&nutanix.ProtectionRuleAvailabilityZoneConnectivityListArgs{
					SnapshotScheduleLists: nutanix.ProtectionRuleAvailabilityZoneConnectivityListSnapshotScheduleListArray{
						&nutanix.ProtectionRuleAvailabilityZoneConnectivityListSnapshotScheduleListArgs{
							RecoveryPointObjectiveSecs: pulumi.Int(3600),
							SnapshotType:               pulumi.String("CRASH_CONSISTENT"),
							LocalSnapshotRetentionPolicy: &nutanix.ProtectionRuleAvailabilityZoneConnectivityListSnapshotScheduleListLocalSnapshotRetentionPolicyArgs{
								NumSnapshots: pulumi.Int(1),
							},
						},
					},
				},
			},
			CategoryFilter: &nutanix.ProtectionRuleCategoryFilterArgs{
				Params: nutanix.ProtectionRuleCategoryFilterParamArray{
					&nutanix.ProtectionRuleCategoryFilterParamArgs{
						Name: pulumi.String("Environment"),
						Values: pulumi.StringArray{
							pulumi.String("Dev"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		_ = nutanix.LookupProtectionRuleOutput(ctx, nutanix.GetProtectionRuleOutputArgs{
			ProtectionRuleId: protectionRuleTest.ID(),
		}, nil)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nutanix = PiersKarsenbarg.Nutanix;
using Nutanix = Pulumi.Nutanix;

return await Deployment.RunAsync(() => 
{
    var protectionRuleTest = new Nutanix.ProtectionRule("protection_rule_test", new()
    {
        Name = "test",
        Description = "test",
        OrderedAvailabilityZoneLists = new[]
        {
            new Nutanix.Inputs.ProtectionRuleOrderedAvailabilityZoneListArgs
            {
                AvailabilityZoneUrl = "ab788130-0820-4d07-a1b5-b0ba4d3a42asd",
            },
        },
        AvailabilityZoneConnectivityLists = new[]
        {
            new Nutanix.Inputs.ProtectionRuleAvailabilityZoneConnectivityListArgs
            {
                SnapshotScheduleLists = new[]
                {
                    new Nutanix.Inputs.ProtectionRuleAvailabilityZoneConnectivityListSnapshotScheduleListArgs
                    {
                        RecoveryPointObjectiveSecs = 3600,
                        SnapshotType = "CRASH_CONSISTENT",
                        LocalSnapshotRetentionPolicy = new Nutanix.Inputs.ProtectionRuleAvailabilityZoneConnectivityListSnapshotScheduleListLocalSnapshotRetentionPolicyArgs
                        {
                            NumSnapshots = 1,
                        },
                    },
                },
            },
        },
        CategoryFilter = new Nutanix.Inputs.ProtectionRuleCategoryFilterArgs
        {
            Params = new[]
            {
                new Nutanix.Inputs.ProtectionRuleCategoryFilterParamArgs
                {
                    Name = "Environment",
                    Values = new[]
                    {
                        "Dev",
                    },
                },
            },
        },
    });

    var test = Nutanix.GetProtectionRule.Invoke(new()
    {
        ProtectionRuleId = protectionRuleTest.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.ProtectionRule;
import com.pulumi.nutanix.ProtectionRuleArgs;
import com.pulumi.nutanix.inputs.ProtectionRuleOrderedAvailabilityZoneListArgs;
import com.pulumi.nutanix.inputs.ProtectionRuleAvailabilityZoneConnectivityListArgs;
import com.pulumi.nutanix.inputs.ProtectionRuleCategoryFilterArgs;
import com.pulumi.nutanix.NutanixFunctions;
import com.pulumi.nutanix.inputs.GetProtectionRuleArgs;
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 protectionRuleTest = new ProtectionRule("protectionRuleTest", ProtectionRuleArgs.builder()
            .name("test")
            .description("test")
            .orderedAvailabilityZoneLists(ProtectionRuleOrderedAvailabilityZoneListArgs.builder()
                .availabilityZoneUrl("ab788130-0820-4d07-a1b5-b0ba4d3a42asd")
                .build())
            .availabilityZoneConnectivityLists(ProtectionRuleAvailabilityZoneConnectivityListArgs.builder()
                .snapshotScheduleLists(ProtectionRuleAvailabilityZoneConnectivityListSnapshotScheduleListArgs.builder()
                    .recoveryPointObjectiveSecs(3600)
                    .snapshotType("CRASH_CONSISTENT")
                    .localSnapshotRetentionPolicy(ProtectionRuleAvailabilityZoneConnectivityListSnapshotScheduleListLocalSnapshotRetentionPolicyArgs.builder()
                        .numSnapshots(1)
                        .build())
                    .build())
                .build())
            .categoryFilter(ProtectionRuleCategoryFilterArgs.builder()
                .params(ProtectionRuleCategoryFilterParamArgs.builder()
                    .name("Environment")
                    .values("Dev")
                    .build())
                .build())
            .build());

        final var test = NutanixFunctions.getProtectionRule(GetProtectionRuleArgs.builder()
            .protectionRuleId(protectionRuleTest.id())
            .build());

    }
}

resources:
  protectionRuleTest:
    type: nutanix:ProtectionRule
    name: protection_rule_test
    properties:
      name: test
      description: test
      orderedAvailabilityZoneLists:
        - availabilityZoneUrl: ab788130-0820-4d07-a1b5-b0ba4d3a42asd
      availabilityZoneConnectivityLists:
        - snapshotScheduleLists:
            - recoveryPointObjectiveSecs: 3600
              snapshotType: CRASH_CONSISTENT
              localSnapshotRetentionPolicy:
                numSnapshots: 1
      categoryFilter:
        params:
          - name: Environment
            values:
              - Dev
variables:
  test:
    fn::invoke:
      function: nutanix:getProtectionRule
      arguments:
        protectionRuleId: ${protectionRuleTest.id}

Using getProtectionRule

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 getProtectionRule(args: GetProtectionRuleArgs, opts?: InvokeOptions): Promise<GetProtectionRuleResult>
function getProtectionRuleOutput(args: GetProtectionRuleOutputArgs, opts?: InvokeOptions): Output<GetProtectionRuleResult>

def get_protection_rule(categories: Optional[Sequence[GetProtectionRuleCategory]] = None,
                        protection_rule_id: Optional[str] = None,
                        protection_rule_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetProtectionRuleResult
def get_protection_rule_output(categories: Optional[pulumi.Input[Sequence[pulumi.Input[GetProtectionRuleCategoryArgs]]]] = None,
                        protection_rule_id: Optional[pulumi.Input[str]] = None,
                        protection_rule_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetProtectionRuleResult]

func LookupProtectionRule(ctx *Context, args *LookupProtectionRuleArgs, opts ...InvokeOption) (*LookupProtectionRuleResult, error)
func LookupProtectionRuleOutput(ctx *Context, args *LookupProtectionRuleOutputArgs, opts ...InvokeOption) LookupProtectionRuleResultOutput

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

public static class GetProtectionRule 
{
    public static Task<GetProtectionRuleResult> InvokeAsync(GetProtectionRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetProtectionRuleResult> Invoke(GetProtectionRuleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetProtectionRuleResult> getProtectionRule(GetProtectionRuleArgs args, InvokeOptions options)
public static Output<GetProtectionRuleResult> getProtectionRule(GetProtectionRuleArgs args, InvokeOptions options)

fn::invoke:
  function: nutanix:index/getProtectionRule:getProtectionRule
  arguments:
    # arguments dictionary

The following arguments are supported:

Categories List<PiersKarsenbarg.Nutanix.Inputs.GetProtectionRuleCategory>

ProtectionRuleId string

(Required) The id of the protection rule.

ProtectionRuleName string

Categories []GetProtectionRuleCategory

ProtectionRuleId string

(Required) The id of the protection rule.

ProtectionRuleName string

categories List<GetProtectionRuleCategory>

protectionRuleId String

(Required) The id of the protection rule.

protectionRuleName String

categories GetProtectionRuleCategory[]

protectionRuleId string

(Required) The id of the protection rule.

protectionRuleName string

categories Sequence[GetProtectionRuleCategory]

protection_rule_id str

(Required) The id of the protection rule.

protection_rule_name str

categories List<Property Map>

protectionRuleId String

(Required) The id of the protection rule.

protectionRuleName String

getProtectionRule Result

The following output properties are available:

ApiVersion string

AvailabilityZoneConnectivityLists List<PiersKarsenbarg.Nutanix.Outputs.GetProtectionRuleAvailabilityZoneConnectivityList>

(Required) This encodes the datapipes between various availability zones and\nthe backup policy of the pipes.

Categories List<PiersKarsenbarg.Nutanix.Outputs.GetProtectionRuleCategory>

CategoryFilters List<PiersKarsenbarg.Nutanix.Outputs.GetProtectionRuleCategoryFilter>

(Optional/Computed)

Description string

A description for protection rule.

Id string

The provider-assigned unique ID for this managed resource.

Metadata Dictionary<string, string>

Name string

(Optional) the name.

OrderedAvailabilityZoneLists List<PiersKarsenbarg.Nutanix.Outputs.GetProtectionRuleOrderedAvailabilityZoneList>

(Required) A list of availability zones, each of which, receives a replica\nof the data for the entities protected by this protection rule.

ordered_availability_zone_list.#.cluster_uuid - (Optional/Computed) UUID of specific cluster to which we will be replicating.
ordered_availability_zone_list.#.availability_zone_url - (Optional/Computed) The FQDN or IP address of the availability zone.

OwnerReferences List<PiersKarsenbarg.Nutanix.Outputs.GetProtectionRuleOwnerReference>

ProjectReferences List<PiersKarsenbarg.Nutanix.Outputs.GetProtectionRuleProjectReference>

StartTime string

State string

ProtectionRuleId string

ProtectionRuleName string

ApiVersion string

AvailabilityZoneConnectivityLists []GetProtectionRuleAvailabilityZoneConnectivityList

(Required) This encodes the datapipes between various availability zones and\nthe backup policy of the pipes.

Categories []GetProtectionRuleCategory

CategoryFilters []GetProtectionRuleCategoryFilter

(Optional/Computed)

Description string

A description for protection rule.

Id string

The provider-assigned unique ID for this managed resource.

Metadata map[string]string

Name string

(Optional) the name.

OrderedAvailabilityZoneLists []GetProtectionRuleOrderedAvailabilityZoneList

(Required) A list of availability zones, each of which, receives a replica\nof the data for the entities protected by this protection rule.

ordered_availability_zone_list.#.cluster_uuid - (Optional/Computed) UUID of specific cluster to which we will be replicating.
ordered_availability_zone_list.#.availability_zone_url - (Optional/Computed) The FQDN or IP address of the availability zone.

OwnerReferences []GetProtectionRuleOwnerReference

ProjectReferences []GetProtectionRuleProjectReference

StartTime string

State string

ProtectionRuleId string

ProtectionRuleName string

apiVersion String

availabilityZoneConnectivityLists List<GetProtectionRuleAvailabilityZoneConnectivityList>

(Required) This encodes the datapipes between various availability zones and\nthe backup policy of the pipes.

categories List<GetProtectionRuleCategory>

categoryFilters List<GetProtectionRuleCategoryFilter>

(Optional/Computed)

description String

A description for protection rule.

id String

The provider-assigned unique ID for this managed resource.

metadata Map<String,String>

name String

(Optional) the name.

orderedAvailabilityZoneLists List<GetProtectionRuleOrderedAvailabilityZoneList>

(Required) A list of availability zones, each of which, receives a replica\nof the data for the entities protected by this protection rule.

ordered_availability_zone_list.#.cluster_uuid - (Optional/Computed) UUID of specific cluster to which we will be replicating.
ordered_availability_zone_list.#.availability_zone_url - (Optional/Computed) The FQDN or IP address of the availability zone.

ownerReferences List<GetProtectionRuleOwnerReference>

projectReferences List<GetProtectionRuleProjectReference>

startTime String

state String

protectionRuleId String

protectionRuleName String

apiVersion string

availabilityZoneConnectivityLists GetProtectionRuleAvailabilityZoneConnectivityList[]

(Required) This encodes the datapipes between various availability zones and\nthe backup policy of the pipes.

categories GetProtectionRuleCategory[]

categoryFilters GetProtectionRuleCategoryFilter[]

(Optional/Computed)

description string

A description for protection rule.

id string

The provider-assigned unique ID for this managed resource.

metadata {[key: string]: string}

name string

(Optional) the name.

orderedAvailabilityZoneLists GetProtectionRuleOrderedAvailabilityZoneList[]

(Required) A list of availability zones, each of which, receives a replica\nof the data for the entities protected by this protection rule.

ordered_availability_zone_list.#.cluster_uuid - (Optional/Computed) UUID of specific cluster to which we will be replicating.
ordered_availability_zone_list.#.availability_zone_url - (Optional/Computed) The FQDN or IP address of the availability zone.

ownerReferences GetProtectionRuleOwnerReference[]

projectReferences GetProtectionRuleProjectReference[]

startTime string

state string

protectionRuleId string

protectionRuleName string

api_version str

availability_zone_connectivity_lists Sequence[GetProtectionRuleAvailabilityZoneConnectivityList]

(Required) This encodes the datapipes between various availability zones and\nthe backup policy of the pipes.

categories Sequence[GetProtectionRuleCategory]

category_filters Sequence[GetProtectionRuleCategoryFilter]

(Optional/Computed)

description str

A description for protection rule.

id str

The provider-assigned unique ID for this managed resource.

metadata Mapping[str, str]

name str

(Optional) the name.

ordered_availability_zone_lists Sequence[GetProtectionRuleOrderedAvailabilityZoneList]

(Required) A list of availability zones, each of which, receives a replica\nof the data for the entities protected by this protection rule.

ordered_availability_zone_list.#.cluster_uuid - (Optional/Computed) UUID of specific cluster to which we will be replicating.
ordered_availability_zone_list.#.availability_zone_url - (Optional/Computed) The FQDN or IP address of the availability zone.

owner_references Sequence[GetProtectionRuleOwnerReference]

project_references Sequence[GetProtectionRuleProjectReference]

start_time str

state str

protection_rule_id str

protection_rule_name str

apiVersion String

availabilityZoneConnectivityLists List<Property Map>

(Required) This encodes the datapipes between various availability zones and\nthe backup policy of the pipes.

categories List<Property Map>

categoryFilters List<Property Map>

(Optional/Computed)

description String

A description for protection rule.

id String

The provider-assigned unique ID for this managed resource.

metadata Map<String>

name String

(Optional) the name.

orderedAvailabilityZoneLists List<Property Map>

(Required) A list of availability zones, each of which, receives a replica\nof the data for the entities protected by this protection rule.

ordered_availability_zone_list.#.cluster_uuid - (Optional/Computed) UUID of specific cluster to which we will be replicating.
ordered_availability_zone_list.#.availability_zone_url - (Optional/Computed) The FQDN or IP address of the availability zone.

ownerReferences List<Property Map>

projectReferences List<Property Map>

startTime String

state String

protectionRuleId String

protectionRuleName String