f5bigip.ltm.getPolicy

Explore with Pulumi AI

f5 BIG-IP v3.17.10 published on Tuesday, Apr 8, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const test = f5bigip.ltm.getPolicy({
    name: "/Common/test-policy",
});
export const bigipPolicy = test.then(test => test.rules);

import pulumi
import pulumi_f5bigip as f5bigip

test = f5bigip.ltm.get_policy(name="/Common/test-policy")
pulumi.export("bigipPolicy", test.rules)

package main

import (
	"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip/ltm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := ltm.LookupPolicy(ctx, &ltm.LookupPolicyArgs{
			Name: "/Common/test-policy",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("bigipPolicy", test.Rules)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using F5BigIP = Pulumi.F5BigIP;

return await Deployment.RunAsync(() => 
{
    var test = F5BigIP.Ltm.GetPolicy.Invoke(new()
    {
        Name = "/Common/test-policy",
    });

    return new Dictionary<string, object?>
    {
        ["bigipPolicy"] = test.Apply(getPolicyResult => getPolicyResult.Rules),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.f5bigip.ltm.LtmFunctions;
import com.pulumi.f5bigip.ltm.inputs.GetPolicyArgs;
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 test = LtmFunctions.getPolicy(GetPolicyArgs.builder()
            .name("/Common/test-policy")
            .build());

        ctx.export("bigipPolicy", test.applyValue(getPolicyResult -> getPolicyResult.rules()));
    }
}

variables:
  test:
    fn::invoke:
      function: f5bigip:ltm:getPolicy
      arguments:
        name: /Common/test-policy
outputs:
  bigipPolicy: ${test.rules}

Using getPolicy

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.

TypeScript
Python
Go
C#
Java
YAML

function getPolicy(args: GetPolicyArgs, opts?: InvokeOptions): Promise<GetPolicyResult>
function getPolicyOutput(args: GetPolicyOutputArgs, opts?: InvokeOptions): Output<GetPolicyResult>

def get_policy(controls: Optional[Sequence[str]] = None,
               name: Optional[str] = None,
               published_copy: Optional[str] = None,
               requires: Optional[Sequence[str]] = None,
               rules: Optional[Sequence[GetPolicyRule]] = None,
               strategy: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetPolicyResult
def get_policy_output(controls: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               name: Optional[pulumi.Input[str]] = None,
               published_copy: Optional[pulumi.Input[str]] = None,
               requires: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               rules: Optional[pulumi.Input[Sequence[pulumi.Input[GetPolicyRuleArgs]]]] = None,
               strategy: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetPolicyResult]

func LookupPolicy(ctx *Context, args *LookupPolicyArgs, opts ...InvokeOption) (*LookupPolicyResult, error)
func LookupPolicyOutput(ctx *Context, args *LookupPolicyOutputArgs, opts ...InvokeOption) LookupPolicyResultOutput

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

public static class GetPolicy 
{
    public static Task<GetPolicyResult> InvokeAsync(GetPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetPolicyResult> Invoke(GetPolicyInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPolicyResult> getPolicy(GetPolicyArgs args, InvokeOptions options)
public static Output<GetPolicyResult> getPolicy(GetPolicyArgs args, InvokeOptions options)

fn::invoke:
  function: f5bigip:ltm/getPolicy:getPolicy
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Name of the policy which includes partion ( /partition/policy-name )
Controls List<string>: Specifies the controls.
PublishedCopy string
Requires List<string>: Specifies the protocol.
Rules List<Pulumi.F5BigIP.Ltm.Inputs.GetPolicyRule>: Rules defined in the policy.
Strategy string: Specifies the match strategy.

Name string: Name of the policy which includes partion ( /partition/policy-name )
Controls []string: Specifies the controls.
PublishedCopy string
Requires []string: Specifies the protocol.
Rules []GetPolicyRule: Rules defined in the policy.
Strategy string: Specifies the match strategy.

name String: Name of the policy which includes partion ( /partition/policy-name )
controls List<String>: Specifies the controls.
publishedCopy String
requires List<String>: Specifies the protocol.
rules List<GetPolicyRule>: Rules defined in the policy.
strategy String: Specifies the match strategy.

name string: Name of the policy which includes partion ( /partition/policy-name )
controls string[]: Specifies the controls.
publishedCopy string
requires string[]: Specifies the protocol.
rules GetPolicyRule[]: Rules defined in the policy.
strategy string: Specifies the match strategy.

name str: Name of the policy which includes partion ( /partition/policy-name )
controls Sequence[str]: Specifies the controls.
published_copy str
requires Sequence[str]: Specifies the protocol.
rules Sequence[GetPolicyRule]: Rules defined in the policy.
strategy str: Specifies the match strategy.

name String: Name of the policy which includes partion ( /partition/policy-name )
controls List<String>: Specifies the controls.
publishedCopy String
requires List<String>: Specifies the protocol.
rules List<Property Map>: Rules defined in the policy.
strategy String: Specifies the match strategy.

getPolicy Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Name string: The name of the policy.
Controls List<string>: Specifies the controls.
PublishedCopy string
Requires List<string>: Specifies the protocol.
Rules List<Pulumi.F5BigIP.Ltm.Outputs.GetPolicyRule>: Rules defined in the policy.
Strategy string: Specifies the match strategy.

Id string: The provider-assigned unique ID for this managed resource.
Name string: The name of the policy.
Controls []string: Specifies the controls.
PublishedCopy string
Requires []string: Specifies the protocol.
Rules []GetPolicyRule: Rules defined in the policy.
Strategy string: Specifies the match strategy.