avi 31.1.1, Apr 14 25

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

avi.Poolgroupdeploymentpolicy

Explore with Pulumi AI

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

–>
layout: “avi”
page_title: “Avi: avi.Poolgroupdeploymentpolicy” sidebar_current: “docs-avi-resource-poolgroupdeploymentpolicy” description: |- Creates and manages Avi PoolGroupDeploymentPolicy.
Example Usage
Create Poolgroupdeploymentpolicy Resource
Constructor syntax
Constructor example
Poolgroupdeploymentpolicy Resource Properties
Inputs
Outputs
Look up Existing Poolgroupdeploymentpolicy Resource
Supporting Types
Package Details

Request a Change

<!–

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

–>

layout: “avi”

page_title: “Avi: avi.Poolgroupdeploymentpolicy” sidebar_current: “docs-avi-resource-poolgroupdeploymentpolicy” description: |- Creates and manages Avi PoolGroupDeploymentPolicy.

avi.Poolgroupdeploymentpolicy

The PoolGroupDeploymentPolicy resource allows the creation and management of Avi PoolGroupDeploymentPolicy

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

const foo = new avi.Poolgroupdeploymentpolicy("foo", {tenantRef: "/api/tenant/?name=admin"});

import pulumi
import pulumi_avi as avi

foo = avi.Poolgroupdeploymentpolicy("foo", tenant_ref="/api/tenant/?name=admin")

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.NewPoolgroupdeploymentpolicy(ctx, "foo", &avi.PoolgroupdeploymentpolicyArgs{
			TenantRef: pulumi.String("/api/tenant/?name=admin"),
		})
		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 foo = new Avi.Poolgroupdeploymentpolicy("foo", new()
    {
        TenantRef = "/api/tenant/?name=admin",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.Poolgroupdeploymentpolicy;
import com.pulumi.avi.PoolgroupdeploymentpolicyArgs;
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 foo = new Poolgroupdeploymentpolicy("foo", PoolgroupdeploymentpolicyArgs.builder()
            .tenantRef("/api/tenant/?name=admin")
            .build());

    }
}

resources:
  foo:
    type: avi:Poolgroupdeploymentpolicy
    properties:
      tenantRef: /api/tenant/?name=admin

Create Poolgroupdeploymentpolicy Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

TypeScript
Python
Go
C#
Java
YAML

new Poolgroupdeploymentpolicy(name: string, args?: PoolgroupdeploymentpolicyArgs, opts?: CustomResourceOptions);

@overload
def Poolgroupdeploymentpolicy(resource_name: str,
                              args: Optional[PoolgroupdeploymentpolicyArgs] = None,
                              opts: Optional[ResourceOptions] = None)

@overload
def Poolgroupdeploymentpolicy(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              auto_disable_old_prod_pools: Optional[str] = None,
                              configpb_attributes: Optional[Sequence[PoolgroupdeploymentpolicyConfigpbAttributeArgs]] = None,
                              description: Optional[str] = None,
                              evaluation_duration: Optional[str] = None,
                              markers: Optional[Sequence[PoolgroupdeploymentpolicyMarkerArgs]] = None,
                              name: Optional[str] = None,
                              poolgroupdeploymentpolicy_id: Optional[str] = None,
                              rules: Optional[Sequence[PoolgroupdeploymentpolicyRuleArgs]] = None,
                              scheme: Optional[str] = None,
                              target_test_traffic_ratio: Optional[str] = None,
                              tenant_ref: Optional[str] = None,
                              test_traffic_ratio_rampup: Optional[str] = None,
                              uuid: Optional[str] = None,
                              webhook_ref: Optional[str] = None)

func NewPoolgroupdeploymentpolicy(ctx *Context, name string, args *PoolgroupdeploymentpolicyArgs, opts ...ResourceOption) (*Poolgroupdeploymentpolicy, error)

public Poolgroupdeploymentpolicy(string name, PoolgroupdeploymentpolicyArgs? args = null, CustomResourceOptions? opts = null)

public Poolgroupdeploymentpolicy(String name, PoolgroupdeploymentpolicyArgs args)
public Poolgroupdeploymentpolicy(String name, PoolgroupdeploymentpolicyArgs args, CustomResourceOptions options)

type: avi:Poolgroupdeploymentpolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args PoolgroupdeploymentpolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args PoolgroupdeploymentpolicyArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args PoolgroupdeploymentpolicyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PoolgroupdeploymentpolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PoolgroupdeploymentpolicyArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

TypeScript
Python
Go
C#
Java
YAML

var poolgroupdeploymentpolicyResource = new Avi.Poolgroupdeploymentpolicy("poolgroupdeploymentpolicyResource", new()
{
    AutoDisableOldProdPools = "string",
    ConfigpbAttributes = new[]
    {
        new Avi.Inputs.PoolgroupdeploymentpolicyConfigpbAttributeArgs
        {
            Version = "string",
        },
    },
    Description = "string",
    EvaluationDuration = "string",
    Markers = new[]
    {
        new Avi.Inputs.PoolgroupdeploymentpolicyMarkerArgs
        {
            Key = "string",
            Values = new[]
            {
                "string",
            },
        },
    },
    Name = "string",
    PoolgroupdeploymentpolicyId = "string",
    Rules = new[]
    {
        new Avi.Inputs.PoolgroupdeploymentpolicyRuleArgs
        {
            MetricId = "string",
            Operator = "string",
            Threshold = "string",
        },
    },
    Scheme = "string",
    TargetTestTrafficRatio = "string",
    TenantRef = "string",
    TestTrafficRatioRampup = "string",
    Uuid = "string",
    WebhookRef = "string",
});

example, err := avi.NewPoolgroupdeploymentpolicy(ctx, "poolgroupdeploymentpolicyResource", &avi.PoolgroupdeploymentpolicyArgs{
AutoDisableOldProdPools: pulumi.String("string"),
ConfigpbAttributes: .PoolgroupdeploymentpolicyConfigpbAttributeArray{
&.PoolgroupdeploymentpolicyConfigpbAttributeArgs{
Version: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
EvaluationDuration: pulumi.String("string"),
Markers: .PoolgroupdeploymentpolicyMarkerArray{
&.PoolgroupdeploymentpolicyMarkerArgs{
Key: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Name: pulumi.String("string"),
PoolgroupdeploymentpolicyId: pulumi.String("string"),
Rules: .PoolgroupdeploymentpolicyRuleArray{
&.PoolgroupdeploymentpolicyRuleArgs{
MetricId: pulumi.String("string"),
Operator: pulumi.String("string"),
Threshold: pulumi.String("string"),
},
},
Scheme: pulumi.String("string"),
TargetTestTrafficRatio: pulumi.String("string"),
TenantRef: pulumi.String("string"),
TestTrafficRatioRampup: pulumi.String("string"),
Uuid: pulumi.String("string"),
WebhookRef: pulumi.String("string"),
})

var poolgroupdeploymentpolicyResource = new Poolgroupdeploymentpolicy("poolgroupdeploymentpolicyResource", PoolgroupdeploymentpolicyArgs.builder()
    .autoDisableOldProdPools("string")
    .configpbAttributes(PoolgroupdeploymentpolicyConfigpbAttributeArgs.builder()
        .version("string")
        .build())
    .description("string")
    .evaluationDuration("string")
    .markers(PoolgroupdeploymentpolicyMarkerArgs.builder()
        .key("string")
        .values("string")
        .build())
    .name("string")
    .poolgroupdeploymentpolicyId("string")
    .rules(PoolgroupdeploymentpolicyRuleArgs.builder()
        .metricId("string")
        .operator("string")
        .threshold("string")
        .build())
    .scheme("string")
    .targetTestTrafficRatio("string")
    .tenantRef("string")
    .testTrafficRatioRampup("string")
    .uuid("string")
    .webhookRef("string")
    .build());

poolgroupdeploymentpolicy_resource = avi.Poolgroupdeploymentpolicy("poolgroupdeploymentpolicyResource",
    auto_disable_old_prod_pools="string",
    configpb_attributes=[{
        "version": "string",
    }],
    description="string",
    evaluation_duration="string",
    markers=[{
        "key": "string",
        "values": ["string"],
    }],
    name="string",
    poolgroupdeploymentpolicy_id="string",
    rules=[{
        "metric_id": "string",
        "operator": "string",
        "threshold": "string",
    }],
    scheme="string",
    target_test_traffic_ratio="string",
    tenant_ref="string",
    test_traffic_ratio_rampup="string",
    uuid="string",
    webhook_ref="string")

const poolgroupdeploymentpolicyResource = new avi.Poolgroupdeploymentpolicy("poolgroupdeploymentpolicyResource", {
    autoDisableOldProdPools: "string",
    configpbAttributes: [{
        version: "string",
    }],
    description: "string",
    evaluationDuration: "string",
    markers: [{
        key: "string",
        values: ["string"],
    }],
    name: "string",
    poolgroupdeploymentpolicyId: "string",
    rules: [{
        metricId: "string",
        operator: "string",
        threshold: "string",
    }],
    scheme: "string",
    targetTestTrafficRatio: "string",
    tenantRef: "string",
    testTrafficRatioRampup: "string",
    uuid: "string",
    webhookRef: "string",
});

type: avi:Poolgroupdeploymentpolicy
properties:
    autoDisableOldProdPools: string
    configpbAttributes:
        - version: string
    description: string
    evaluationDuration: string
    markers:
        - key: string
          values:
            - string
    name: string
    poolgroupdeploymentpolicyId: string
    rules:
        - metricId: string
          operator: string
          threshold: string
    scheme: string
    targetTestTrafficRatio: string
    tenantRef: string
    testTrafficRatioRampup: string
    uuid: string
    webhookRef: string

Poolgroupdeploymentpolicy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Poolgroupdeploymentpolicy resource accepts the following input properties:

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<PoolgroupdeploymentpolicyConfigpbAttribute>: 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.
Markers List<PoolgroupdeploymentpolicyMarker>: 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.
PoolgroupdeploymentpolicyId string
Rules List<PoolgroupdeploymentpolicyRule>: 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 []PoolgroupdeploymentpolicyConfigpbAttributeArgs: 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.
Markers []PoolgroupdeploymentpolicyMarkerArgs: 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.
PoolgroupdeploymentpolicyId string
Rules []PoolgroupdeploymentpolicyRuleArgs: 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<PoolgroupdeploymentpolicyConfigpbAttribute>: 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.
markers List<PoolgroupdeploymentpolicyMarker>: 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.
poolgroupdeploymentpolicyId String
rules List<PoolgroupdeploymentpolicyRule>: 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 PoolgroupdeploymentpolicyConfigpbAttribute[]: 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.
markers PoolgroupdeploymentpolicyMarker[]: 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.
poolgroupdeploymentpolicyId string
rules PoolgroupdeploymentpolicyRule[]: 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[PoolgroupdeploymentpolicyConfigpbAttributeArgs]: 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.
markers Sequence[PoolgroupdeploymentpolicyMarkerArgs]: 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.
poolgroupdeploymentpolicy_id str
rules Sequence[PoolgroupdeploymentpolicyRuleArgs]: 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.
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.
poolgroupdeploymentpolicyId String
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Poolgroupdeploymentpolicy resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing Poolgroupdeploymentpolicy Resource

Get an existing Poolgroupdeploymentpolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: PoolgroupdeploymentpolicyState, opts?: CustomResourceOptions): Poolgroupdeploymentpolicy

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_disable_old_prod_pools: Optional[str] = None,
        configpb_attributes: Optional[Sequence[PoolgroupdeploymentpolicyConfigpbAttributeArgs]] = None,
        description: Optional[str] = None,
        evaluation_duration: Optional[str] = None,
        markers: Optional[Sequence[PoolgroupdeploymentpolicyMarkerArgs]] = None,
        name: Optional[str] = None,
        poolgroupdeploymentpolicy_id: Optional[str] = None,
        rules: Optional[Sequence[PoolgroupdeploymentpolicyRuleArgs]] = None,
        scheme: Optional[str] = None,
        target_test_traffic_ratio: Optional[str] = None,
        tenant_ref: Optional[str] = None,
        test_traffic_ratio_rampup: Optional[str] = None,
        uuid: Optional[str] = None,
        webhook_ref: Optional[str] = None) -> Poolgroupdeploymentpolicy

func GetPoolgroupdeploymentpolicy(ctx *Context, name string, id IDInput, state *PoolgroupdeploymentpolicyState, opts ...ResourceOption) (*Poolgroupdeploymentpolicy, error)

public static Poolgroupdeploymentpolicy Get(string name, Input<string> id, PoolgroupdeploymentpolicyState? state, CustomResourceOptions? opts = null)

public static Poolgroupdeploymentpolicy get(String name, Output<String> id, PoolgroupdeploymentpolicyState state, CustomResourceOptions options)

resources:  _:    type: avi:Poolgroupdeploymentpolicy    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

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<PoolgroupdeploymentpolicyConfigpbAttribute>: 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.
Markers List<PoolgroupdeploymentpolicyMarker>: 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.
PoolgroupdeploymentpolicyId string
Rules List<PoolgroupdeploymentpolicyRule>: 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 []PoolgroupdeploymentpolicyConfigpbAttributeArgs: 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.
Markers []PoolgroupdeploymentpolicyMarkerArgs: 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.
PoolgroupdeploymentpolicyId string
Rules []PoolgroupdeploymentpolicyRuleArgs: 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<PoolgroupdeploymentpolicyConfigpbAttribute>: 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.
markers List<PoolgroupdeploymentpolicyMarker>: 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.
poolgroupdeploymentpolicyId String
rules List<PoolgroupdeploymentpolicyRule>: 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 PoolgroupdeploymentpolicyConfigpbAttribute[]: 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.
markers PoolgroupdeploymentpolicyMarker[]: 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.
poolgroupdeploymentpolicyId string
rules PoolgroupdeploymentpolicyRule[]: 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[PoolgroupdeploymentpolicyConfigpbAttributeArgs]: 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.
markers Sequence[PoolgroupdeploymentpolicyMarkerArgs]: 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.
poolgroupdeploymentpolicy_id str
rules Sequence[PoolgroupdeploymentpolicyRuleArgs]: 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.
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.
poolgroupdeploymentpolicyId String
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.