pulumi-azure-kotlin/com.pulumi.azure.policy.kotlin/PolicyFunctions/getPolicyDefintion

getPolicyDefintion

suspend fun getPolicyDefintion(argument: GetPolicyDefintionPlainArgs): GetPolicyDefintionResult

Use this data source to access information about a Policy Definition, both custom and built in. Retrieves Policy Definitions from your current subscription by default.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.policy.PolicyFunctions;
import com.pulumi.azure.policy.inputs.GetPolicyDefintionArgs;
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 example = PolicyFunctions.getPolicyDefintion(GetPolicyDefintionArgs.builder()
            .displayName("Allowed resource types")
            .build());
        ctx.export("id", example.applyValue(getPolicyDefintionResult -> getPolicyDefintionResult.id()));
    }
}
Content copied to clipboard

Return

A collection of values returned by getPolicyDefintion.

Parameters

argument

A collection of arguments for invoking getPolicyDefintion.

suspend fun getPolicyDefintion(displayName: String? = null, managementGroupName: String? = null, name: String? = null): GetPolicyDefintionResult

Return

A collection of values returned by getPolicyDefintion.

See also

Parameters

displayName

Specifies the display name of the Policy Definition. Conflicts with name.

NOTE Looking up policies by display_name is not recommended by the Azure Policy team as the property is not unique nor immutable. As such errors may occur when there are multiple policy definitions with same display name or the display name is changed. To avoid these types of errors you may wish to use the name property instead.

managementGroupName

Only retrieve Policy Definitions from this Management Group.

name

Specifies the name of the Policy Definition. Conflicts with display_name.

suspend fun getPolicyDefintion(argument: suspend GetPolicyDefintionPlainArgsBuilder.() -> Unit): GetPolicyDefintionResult

Return

A collection of values returned by getPolicyDefintion.

See also

Parameters

argument

Builder for com.pulumi.azure.policy.kotlin.inputs.GetPolicyDefintionPlainArgs.