1. Packages
  2. Avi Provider
  3. API Docs
  4. getPoolgroupdeploymentpolicy
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

avi.getPoolgroupdeploymentpolicy

Explore with Pulumi AI

avi logo
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

    <!–

    Copyright 2021 VMware, Inc.
    SPDX-License-Identifier: Mozilla Public License 2.0
    

    –>

    layout: “avi”

    page_title: “AVI: avi.Poolgroupdeploymentpolicy” sidebar_current: “docs-avi-datasource-poolgroupdeploymentpolicy” description: |- Get information of Avi PoolGroupDeploymentPolicy.

    avi.Poolgroupdeploymentpolicy

    This data source is used to to get avi.Poolgroupdeploymentpolicy objects.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as avi from "@pulumi/avi";
    
    const fooPoolgroupdeploymentpolicy = avi.getPoolgroupdeploymentpolicy({
        name: "foo",
        uuid: "poolgroupdeploymentpolicy-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    });
    
    import pulumi
    import pulumi_avi as avi
    
    foo_poolgroupdeploymentpolicy = avi.get_poolgroupdeploymentpolicy(name="foo",
        uuid="poolgroupdeploymentpolicy-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := avi.LookupPoolgroupdeploymentpolicy(ctx, &avi.LookupPoolgroupdeploymentpolicyArgs{
    			Name: pulumi.StringRef("foo"),
    			Uuid: pulumi.StringRef("poolgroupdeploymentpolicy-f9cf6b3e-a411-436f-95e2-2982ba2b217b"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Avi = Pulumi.Avi;
    
    return await Deployment.RunAsync(() => 
    {
        var fooPoolgroupdeploymentpolicy = Avi.GetPoolgroupdeploymentpolicy.Invoke(new()
        {
            Name = "foo",
            Uuid = "poolgroupdeploymentpolicy-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.avi.AviFunctions;
    import com.pulumi.avi.inputs.GetPoolgroupdeploymentpolicyArgs;
    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 fooPoolgroupdeploymentpolicy = AviFunctions.getPoolgroupdeploymentpolicy(GetPoolgroupdeploymentpolicyArgs.builder()
                .name("foo")
                .uuid("poolgroupdeploymentpolicy-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
                .build());
    
        }
    }
    
    variables:
      fooPoolgroupdeploymentpolicy:
        fn::invoke:
          function: avi:getPoolgroupdeploymentpolicy
          arguments:
            name: foo
            uuid: poolgroupdeploymentpolicy-f9cf6b3e-a411-436f-95e2-2982ba2b217b
    

    Using getPoolgroupdeploymentpolicy

    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 getPoolgroupdeploymentpolicy(args: GetPoolgroupdeploymentpolicyArgs, opts?: InvokeOptions): Promise<GetPoolgroupdeploymentpolicyResult>
    function getPoolgroupdeploymentpolicyOutput(args: GetPoolgroupdeploymentpolicyOutputArgs, opts?: InvokeOptions): Output<GetPoolgroupdeploymentpolicyResult>
    def get_poolgroupdeploymentpolicy(id: Optional[str] = None,
                                      name: Optional[str] = None,
                                      tenant_ref: Optional[str] = None,
                                      uuid: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetPoolgroupdeploymentpolicyResult
    def get_poolgroupdeploymentpolicy_output(id: Optional[pulumi.Input[str]] = None,
                                      name: Optional[pulumi.Input[str]] = None,
                                      tenant_ref: Optional[pulumi.Input[str]] = None,
                                      uuid: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetPoolgroupdeploymentpolicyResult]
    func LookupPoolgroupdeploymentpolicy(ctx *Context, args *LookupPoolgroupdeploymentpolicyArgs, opts ...InvokeOption) (*LookupPoolgroupdeploymentpolicyResult, error)
    func LookupPoolgroupdeploymentpolicyOutput(ctx *Context, args *LookupPoolgroupdeploymentpolicyOutputArgs, opts ...InvokeOption) LookupPoolgroupdeploymentpolicyResultOutput

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

    public static class GetPoolgroupdeploymentpolicy 
    {
        public static Task<GetPoolgroupdeploymentpolicyResult> InvokeAsync(GetPoolgroupdeploymentpolicyArgs args, InvokeOptions? opts = null)
        public static Output<GetPoolgroupdeploymentpolicyResult> Invoke(GetPoolgroupdeploymentpolicyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPoolgroupdeploymentpolicyResult> getPoolgroupdeploymentpolicy(GetPoolgroupdeploymentpolicyArgs args, InvokeOptions options)
    public static Output<GetPoolgroupdeploymentpolicyResult> getPoolgroupdeploymentpolicy(GetPoolgroupdeploymentpolicyArgs args, InvokeOptions options)
    
    fn::invoke:
      function: avi:index/getPoolgroupdeploymentpolicy:getPoolgroupdeploymentpolicy
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Name string
    Search PoolGroupDeploymentPolicy by name.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Search PoolGroupDeploymentPolicy by uuid.
    Id string
    Name string
    Search PoolGroupDeploymentPolicy by name.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Search PoolGroupDeploymentPolicy by uuid.
    id String
    name String
    Search PoolGroupDeploymentPolicy by name.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Search PoolGroupDeploymentPolicy by uuid.
    id string
    name string
    Search PoolGroupDeploymentPolicy by name.
    tenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Search PoolGroupDeploymentPolicy by uuid.
    id str
    name str
    Search PoolGroupDeploymentPolicy by name.
    tenant_ref str
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid str
    Search PoolGroupDeploymentPolicy by uuid.
    id String
    name String
    Search PoolGroupDeploymentPolicy by name.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Search PoolGroupDeploymentPolicy by uuid.

    getPoolgroupdeploymentpolicy Result

    The following output properties are available:

    AutoDisableOldProdPools string
    It will automatically disable old production pools once there is a new production candidate. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes List<GetPoolgroupdeploymentpolicyConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Description string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    EvaluationDuration string
    Duration of evaluation period for automatic deployment. Allowed values are 60-86400. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Id string
    Markers List<GetPoolgroupdeploymentpolicyMarker>
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    The name of the pool group deployment policy. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Rules List<GetPoolgroupdeploymentpolicyRule>
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Scheme string
    Deployment scheme. Enum options - BLUE_GREEN, CANARY. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TargetTestTrafficRatio string
    Target traffic ratio before pool is made production. Allowed values are 1-100. Unit is ratio. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TestTrafficRatioRampup string
    Ratio of the traffic that is sent to the pool under test. Test ratio of 100 means blue green. Allowed values are 1-100. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Uuid of the pool group deployment policy. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    WebhookRef string
    Webhook configured with url that avi controller will pass back information about pool group, old and new pool information and current deployment rule results. It is a reference to an object of type webhook. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    AutoDisableOldProdPools string
    It will automatically disable old production pools once there is a new production candidate. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes []GetPoolgroupdeploymentpolicyConfigpbAttribute
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Description string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    EvaluationDuration string
    Duration of evaluation period for automatic deployment. Allowed values are 60-86400. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Id string
    Markers []GetPoolgroupdeploymentpolicyMarker
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    The name of the pool group deployment policy. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Rules []GetPoolgroupdeploymentpolicyRule
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Scheme string
    Deployment scheme. Enum options - BLUE_GREEN, CANARY. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TargetTestTrafficRatio string
    Target traffic ratio before pool is made production. Allowed values are 1-100. Unit is ratio. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TestTrafficRatioRampup string
    Ratio of the traffic that is sent to the pool under test. Test ratio of 100 means blue green. Allowed values are 1-100. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Uuid of the pool group deployment policy. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    WebhookRef string
    Webhook configured with url that avi controller will pass back information about pool group, old and new pool information and current deployment rule results. It is a reference to an object of type webhook. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    autoDisableOldProdPools String
    It will automatically disable old production pools once there is a new production candidate. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<GetPoolgroupdeploymentpolicyConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    evaluationDuration String
    Duration of evaluation period for automatic deployment. Allowed values are 60-86400. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    id String
    markers List<GetPoolgroupdeploymentpolicyMarker>
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    The name of the pool group deployment policy. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    rules List<GetPoolgroupdeploymentpolicyRule>
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    scheme String
    Deployment scheme. Enum options - BLUE_GREEN, CANARY. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    targetTestTrafficRatio String
    Target traffic ratio before pool is made production. Allowed values are 1-100. Unit is ratio. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    testTrafficRatioRampup String
    Ratio of the traffic that is sent to the pool under test. Test ratio of 100 means blue green. Allowed values are 1-100. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Uuid of the pool group deployment policy. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    webhookRef String
    Webhook configured with url that avi controller will pass back information about pool group, old and new pool information and current deployment rule results. It is a reference to an object of type webhook. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    autoDisableOldProdPools string
    It will automatically disable old production pools once there is a new production candidate. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes GetPoolgroupdeploymentpolicyConfigpbAttribute[]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    evaluationDuration string
    Duration of evaluation period for automatic deployment. Allowed values are 60-86400. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    id string
    markers GetPoolgroupdeploymentpolicyMarker[]
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name string
    The name of the pool group deployment policy. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    rules GetPoolgroupdeploymentpolicyRule[]
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    scheme string
    Deployment scheme. Enum options - BLUE_GREEN, CANARY. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    targetTestTrafficRatio string
    Target traffic ratio before pool is made production. Allowed values are 1-100. Unit is ratio. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    testTrafficRatioRampup string
    Ratio of the traffic that is sent to the pool under test. Test ratio of 100 means blue green. Allowed values are 1-100. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Uuid of the pool group deployment policy. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    webhookRef string
    Webhook configured with url that avi controller will pass back information about pool group, old and new pool information and current deployment rule results. It is a reference to an object of type webhook. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    auto_disable_old_prod_pools str
    It will automatically disable old production pools once there is a new production candidate. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpb_attributes Sequence[GetPoolgroupdeploymentpolicyConfigpbAttribute]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description str
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    evaluation_duration str
    Duration of evaluation period for automatic deployment. Allowed values are 60-86400. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    id str
    markers Sequence[GetPoolgroupdeploymentpolicyMarker]
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name str
    The name of the pool group deployment policy. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    rules Sequence[GetPoolgroupdeploymentpolicyRule]
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    scheme str
    Deployment scheme. Enum options - BLUE_GREEN, CANARY. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    target_test_traffic_ratio str
    Target traffic ratio before pool is made production. Allowed values are 1-100. Unit is ratio. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenant_ref str
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    test_traffic_ratio_rampup str
    Ratio of the traffic that is sent to the pool under test. Test ratio of 100 means blue green. Allowed values are 1-100. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid str
    Uuid of the pool group deployment policy. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    webhook_ref str
    Webhook configured with url that avi controller will pass back information about pool group, old and new pool information and current deployment rule results. It is a reference to an object of type webhook. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    autoDisableOldProdPools String
    It will automatically disable old production pools once there is a new production candidate. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<Property Map>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    evaluationDuration String
    Duration of evaluation period for automatic deployment. Allowed values are 60-86400. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    id String
    markers List<Property Map>
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    The name of the pool group deployment policy. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    rules List<Property Map>
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    scheme String
    Deployment scheme. Enum options - BLUE_GREEN, CANARY. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    targetTestTrafficRatio String
    Target traffic ratio before pool is made production. Allowed values are 1-100. Unit is ratio. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    testTrafficRatioRampup String
    Ratio of the traffic that is sent to the pool under test. Test ratio of 100 means blue green. Allowed values are 1-100. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Uuid of the pool group deployment policy. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    webhookRef String
    Webhook configured with url that avi controller will pass back information about pool group, old and new pool information and current deployment rule results. It is a reference to an object of type webhook. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

    Supporting Types

    GetPoolgroupdeploymentpolicyConfigpbAttribute

    Version string
    Version string
    version String
    version string
    version String

    GetPoolgroupdeploymentpolicyMarker

    Key string
    Values List<string>
    Key string
    Values []string
    key String
    values List<String>
    key string
    values string[]
    key str
    values Sequence[str]
    key String
    values List<String>

    GetPoolgroupdeploymentpolicyRule

    MetricId string
    Operator string
    Threshold string
    MetricId string
    Operator string
    Threshold string
    metricId String
    operator String
    threshold String
    metricId string
    operator string
    threshold string
    metricId String
    operator String
    threshold String

    Package Details

    Repository
    avi vmware/terraform-provider-avi
    License
    Notes
    This Pulumi package is based on the avi Terraform Provider.
    avi logo
    avi 31.1.1 published on Monday, Apr 14, 2025 by vmware