avi 31.1.1, Apr 14 25

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

avi.Alertscriptconfig

Explore with Pulumi AI

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.Alertscriptconfig” sidebar_current: “docs-avi-resource-alertscriptconfig” description: |- Creates and manages Avi AlertScriptConfig.

avi.Alertscriptconfig

The AlertScriptConfig resource allows the creation and management of Avi AlertScriptConfig

Example Usage

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

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

import pulumi
import pulumi_avi as avi

foo = avi.Alertscriptconfig("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.NewAlertscriptconfig(ctx, "foo", &avi.AlertscriptconfigArgs{
			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.Alertscriptconfig("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.Alertscriptconfig;
import com.pulumi.avi.AlertscriptconfigArgs;
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 Alertscriptconfig("foo", AlertscriptconfigArgs.builder()
            .tenantRef("/api/tenant/?name=admin")
            .build());

    }
}

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

Create Alertscriptconfig Resource

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

Constructor syntax

new Alertscriptconfig(name: string, args?: AlertscriptconfigArgs, opts?: CustomResourceOptions);

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

@overload
def Alertscriptconfig(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      action_script: Optional[str] = None,
                      alertscriptconfig_id: Optional[str] = None,
                      configpb_attributes: Optional[Sequence[AlertscriptconfigConfigpbAttributeArgs]] = None,
                      name: Optional[str] = None,
                      tenant_ref: Optional[str] = None,
                      timeout: Optional[str] = None,
                      uuid: Optional[str] = None)

func NewAlertscriptconfig(ctx *Context, name string, args *AlertscriptconfigArgs, opts ...ResourceOption) (*Alertscriptconfig, error)

public Alertscriptconfig(string name, AlertscriptconfigArgs? args = null, CustomResourceOptions? opts = null)

public Alertscriptconfig(String name, AlertscriptconfigArgs args)
public Alertscriptconfig(String name, AlertscriptconfigArgs args, CustomResourceOptions options)

type: avi:Alertscriptconfig
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 AlertscriptconfigArgs: 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 AlertscriptconfigArgs: 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 AlertscriptconfigArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args AlertscriptconfigArgs: 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.

var alertscriptconfigResource = new Avi.Alertscriptconfig("alertscriptconfigResource", new()
{
    ActionScript = "string",
    AlertscriptconfigId = "string",
    ConfigpbAttributes = new[]
    {
        new Avi.Inputs.AlertscriptconfigConfigpbAttributeArgs
        {
            Version = "string",
        },
    },
    Name = "string",
    TenantRef = "string",
    Timeout = "string",
    Uuid = "string",
});

example, err := avi.NewAlertscriptconfig(ctx, "alertscriptconfigResource", &avi.AlertscriptconfigArgs{
	ActionScript:        pulumi.String("string"),
	AlertscriptconfigId: pulumi.String("string"),
	ConfigpbAttributes: avi.AlertscriptconfigConfigpbAttributeArray{
		&avi.AlertscriptconfigConfigpbAttributeArgs{
			Version: pulumi.String("string"),
		},
	},
	Name:      pulumi.String("string"),
	TenantRef: pulumi.String("string"),
	Timeout:   pulumi.String("string"),
	Uuid:      pulumi.String("string"),
})

var alertscriptconfigResource = new Alertscriptconfig("alertscriptconfigResource", AlertscriptconfigArgs.builder()
    .actionScript("string")
    .alertscriptconfigId("string")
    .configpbAttributes(AlertscriptconfigConfigpbAttributeArgs.builder()
        .version("string")
        .build())
    .name("string")
    .tenantRef("string")
    .timeout("string")
    .uuid("string")
    .build());

alertscriptconfig_resource = avi.Alertscriptconfig("alertscriptconfigResource",
    action_script="string",
    alertscriptconfig_id="string",
    configpb_attributes=[{
        "version": "string",
    }],
    name="string",
    tenant_ref="string",
    timeout="string",
    uuid="string")

const alertscriptconfigResource = new avi.Alertscriptconfig("alertscriptconfigResource", {
    actionScript: "string",
    alertscriptconfigId: "string",
    configpbAttributes: [{
        version: "string",
    }],
    name: "string",
    tenantRef: "string",
    timeout: "string",
    uuid: "string",
});

type: avi:Alertscriptconfig
properties:
    actionScript: string
    alertscriptconfigId: string
    configpbAttributes:
        - version: string
    name: string
    tenantRef: string
    timeout: string
    uuid: string

Alertscriptconfig 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 Alertscriptconfig resource accepts the following input properties:

ActionScript string: User defined alert action script. Please refer to kb.avinetworks.com for more information. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
AlertscriptconfigId string
ConfigpbAttributes List<AlertscriptconfigConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string: A user-friendly name of the script. 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.
Timeout string: Controlscript excution timeout. Field introduced in 22.1.6. Allowed with any value in enterprise, enterprise with cloud services edition.
Uuid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

ActionScript string: User defined alert action script. Please refer to kb.avinetworks.com for more information. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
AlertscriptconfigId string
ConfigpbAttributes []AlertscriptconfigConfigpbAttributeArgs: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string: A user-friendly name of the script. 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.
Timeout string: Controlscript excution timeout. Field introduced in 22.1.6. Allowed with any value in enterprise, enterprise with cloud services edition.
Uuid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

actionScript String: User defined alert action script. Please refer to kb.avinetworks.com for more information. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
alertscriptconfigId String
configpbAttributes List<AlertscriptconfigConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String: A user-friendly name of the script. 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.
timeout String: Controlscript excution timeout. Field introduced in 22.1.6. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

actionScript string: User defined alert action script. Please refer to kb.avinetworks.com for more information. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
alertscriptconfigId string
configpbAttributes AlertscriptconfigConfigpbAttribute[]: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name string: A user-friendly name of the script. 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.
timeout string: Controlscript excution timeout. Field introduced in 22.1.6. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

action_script str: User defined alert action script. Please refer to kb.avinetworks.com for more information. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
alertscriptconfig_id str
configpb_attributes Sequence[AlertscriptconfigConfigpbAttributeArgs]: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name str: A user-friendly name of the script. 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.
timeout str: Controlscript excution timeout. Field introduced in 22.1.6. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

actionScript String: User defined alert action script. Please refer to kb.avinetworks.com for more information. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
alertscriptconfigId String
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.
name String: A user-friendly name of the script. 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.
timeout String: Controlscript excution timeout. Field introduced in 22.1.6. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid String: 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 Alertscriptconfig 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 Alertscriptconfig Resource

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action_script: Optional[str] = None,
        alertscriptconfig_id: Optional[str] = None,
        configpb_attributes: Optional[Sequence[AlertscriptconfigConfigpbAttributeArgs]] = None,
        name: Optional[str] = None,
        tenant_ref: Optional[str] = None,
        timeout: Optional[str] = None,
        uuid: Optional[str] = None) -> Alertscriptconfig

func GetAlertscriptconfig(ctx *Context, name string, id IDInput, state *AlertscriptconfigState, opts ...ResourceOption) (*Alertscriptconfig, error)

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

public static Alertscriptconfig get(String name, Output<String> id, AlertscriptconfigState state, CustomResourceOptions options)

resources:  _:    type: avi:Alertscriptconfig    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:

ActionScript string: User defined alert action script. Please refer to kb.avinetworks.com for more information. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
AlertscriptconfigId string
ConfigpbAttributes List<AlertscriptconfigConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string: A user-friendly name of the script. 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.
Timeout string: Controlscript excution timeout. Field introduced in 22.1.6. Allowed with any value in enterprise, enterprise with cloud services edition.
Uuid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

ActionScript string: User defined alert action script. Please refer to kb.avinetworks.com for more information. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
AlertscriptconfigId string
ConfigpbAttributes []AlertscriptconfigConfigpbAttributeArgs: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string: A user-friendly name of the script. 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.
Timeout string: Controlscript excution timeout. Field introduced in 22.1.6. Allowed with any value in enterprise, enterprise with cloud services edition.
Uuid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

actionScript String: User defined alert action script. Please refer to kb.avinetworks.com for more information. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
alertscriptconfigId String
configpbAttributes List<AlertscriptconfigConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String: A user-friendly name of the script. 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.
timeout String: Controlscript excution timeout. Field introduced in 22.1.6. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

actionScript string: User defined alert action script. Please refer to kb.avinetworks.com for more information. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
alertscriptconfigId string
configpbAttributes AlertscriptconfigConfigpbAttribute[]: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name string: A user-friendly name of the script. 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.
timeout string: Controlscript excution timeout. Field introduced in 22.1.6. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

action_script str: User defined alert action script. Please refer to kb.avinetworks.com for more information. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
alertscriptconfig_id str
configpb_attributes Sequence[AlertscriptconfigConfigpbAttributeArgs]: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name str: A user-friendly name of the script. 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.
timeout str: Controlscript excution timeout. Field introduced in 22.1.6. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

actionScript String: User defined alert action script. Please refer to kb.avinetworks.com for more information. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
alertscriptconfigId String
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.
name String: A user-friendly name of the script. 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.
timeout String: Controlscript excution timeout. Field introduced in 22.1.6. Allowed with any value in enterprise, enterprise with cloud services edition.
uuid String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.