Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Avi Provider
  3. API Docs
  4. Microservicegroup
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi

avi.Microservicegroup

Explore with Pulumi AI

avi logo
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi

    <!–

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

    –>

    layout: “avi”

    page_title: “Avi: avi.Microservicegroup” sidebar_current: “docs-avi-resource-microservicegroup” description: |- Creates and manages Avi MicroServiceGroup.

    avi.Microservicegroup

    The MicroServiceGroup resource allows the creation and management of Avi MicroServiceGroup

    Example Usage

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

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

    import pulumi
import pulumi_avi as avi

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

    }
}

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

    Create Microservicegroup Resource

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

    Constructor syntax

    new Microservicegroup(name: string, args?: MicroservicegroupArgs, opts?: CustomResourceOptions);
    @overload
def Microservicegroup(resource_name: str,
                      args: Optional[MicroservicegroupArgs] = None,
                      opts: Optional[ResourceOptions] = None)

@overload
def Microservicegroup(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      configpb_attributes: Optional[Sequence[MicroservicegroupConfigpbAttributeArgs]] = None,
                      created_by: Optional[str] = None,
                      description: Optional[str] = None,
                      microservicegroup_id: Optional[str] = None,
                      name: Optional[str] = None,
                      service_refs: Optional[Sequence[str]] = None,
                      tenant_ref: Optional[str] = None,
                      uuid: Optional[str] = None)
    func NewMicroservicegroup(ctx *Context, name string, args *MicroservicegroupArgs, opts ...ResourceOption) (*Microservicegroup, error)
    public Microservicegroup(string name, MicroservicegroupArgs? args = null, CustomResourceOptions? opts = null)
    public Microservicegroup(String name, MicroservicegroupArgs args)
public Microservicegroup(String name, MicroservicegroupArgs args, CustomResourceOptions options)

    type: avi:Microservicegroup
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 MicroservicegroupArgs
    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 MicroservicegroupArgs
    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 MicroservicegroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MicroservicegroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MicroservicegroupArgs
    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 microservicegroupResource = new Avi.Microservicegroup("microservicegroupResource", new()
{
    ConfigpbAttributes = new[]
    {
        new Avi.Inputs.MicroservicegroupConfigpbAttributeArgs
        {
            Version = "string",
        },
    },
    CreatedBy = "string",
    Description = "string",
    MicroservicegroupId = "string",
    Name = "string",
    ServiceRefs = new[]
    {
        "string",
    },
    TenantRef = "string",
    Uuid = "string",
});

    example, err := avi.NewMicroservicegroup(ctx, "microservicegroupResource", &avi.MicroservicegroupArgs{
	ConfigpbAttributes: avi.MicroservicegroupConfigpbAttributeArray{
		&avi.MicroservicegroupConfigpbAttributeArgs{
			Version: pulumi.String("string"),
		},
	},
	CreatedBy:           pulumi.String("string"),
	Description:         pulumi.String("string"),
	MicroservicegroupId: pulumi.String("string"),
	Name:                pulumi.String("string"),
	ServiceRefs: pulumi.StringArray{
		pulumi.String("string"),
	},
	TenantRef: pulumi.String("string"),
	Uuid:      pulumi.String("string"),
})

    var microservicegroupResource = new Microservicegroup("microservicegroupResource", MicroservicegroupArgs.builder()
    .configpbAttributes(MicroservicegroupConfigpbAttributeArgs.builder()
        .version("string")
        .build())
    .createdBy("string")
    .description("string")
    .microservicegroupId("string")
    .name("string")
    .serviceRefs("string")
    .tenantRef("string")
    .uuid("string")
    .build());

    microservicegroup_resource = avi.Microservicegroup("microservicegroupResource",
    configpb_attributes=[{
        "version": "string",
    }],
    created_by="string",
    description="string",
    microservicegroup_id="string",
    name="string",
    service_refs=["string"],
    tenant_ref="string",
    uuid="string")

    const microservicegroupResource = new avi.Microservicegroup("microservicegroupResource", {
    configpbAttributes: [{
        version: "string",
    }],
    createdBy: "string",
    description: "string",
    microservicegroupId: "string",
    name: "string",
    serviceRefs: ["string"],
    tenantRef: "string",
    uuid: "string",
});

    type: avi:Microservicegroup
properties:
    configpbAttributes:
        - version: string
    createdBy: string
    description: string
    microservicegroupId: string
    name: string
    serviceRefs:
        - string
    tenantRef: string
    uuid: string

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

    ConfigpbAttributes List<MicroservicegroupConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CreatedBy string
    Creator name. 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.
    MicroservicegroupId string
    Name string
    Name of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ServiceRefs List<string>
    Configure microservice(es). It is a reference to an object of type microservice. 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.
    Uuid string
    Uuid of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes []MicroservicegroupConfigpbAttributeArgs
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CreatedBy string
    Creator name. 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.
    MicroservicegroupId string
    Name string
    Name of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ServiceRefs []string
    Configure microservice(es). It is a reference to an object of type microservice. 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.
    Uuid string
    Uuid of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<MicroservicegroupConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    createdBy String
    Creator name. 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.
    microservicegroupId String
    name String
    Name of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serviceRefs List<String>
    Configure microservice(es). It is a reference to an object of type microservice. 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.
    uuid String
    Uuid of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes MicroservicegroupConfigpbAttribute[]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    createdBy string
    Creator name. 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.
    microservicegroupId string
    name string
    Name of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serviceRefs string[]
    Configure microservice(es). It is a reference to an object of type microservice. 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.
    uuid string
    Uuid of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpb_attributes Sequence[MicroservicegroupConfigpbAttributeArgs]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    created_by str
    Creator name. 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.
    microservicegroup_id str
    name str
    Name of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    service_refs Sequence[str]
    Configure microservice(es). It is a reference to an object of type microservice. 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.
    uuid str
    Uuid of the microservice group. 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.
    createdBy String
    Creator name. 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.
    microservicegroupId String
    name String
    Name of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serviceRefs List<String>
    Configure microservice(es). It is a reference to an object of type microservice. 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.
    uuid String
    Uuid of the microservice group. 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 Microservicegroup 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 Microservicegroup Resource

    Get an existing Microservicegroup 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?: MicroservicegroupState, opts?: CustomResourceOptions): Microservicegroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configpb_attributes: Optional[Sequence[MicroservicegroupConfigpbAttributeArgs]] = None,
        created_by: Optional[str] = None,
        description: Optional[str] = None,
        microservicegroup_id: Optional[str] = None,
        name: Optional[str] = None,
        service_refs: Optional[Sequence[str]] = None,
        tenant_ref: Optional[str] = None,
        uuid: Optional[str] = None) -> Microservicegroup
    func GetMicroservicegroup(ctx *Context, name string, id IDInput, state *MicroservicegroupState, opts ...ResourceOption) (*Microservicegroup, error)
    public static Microservicegroup Get(string name, Input<string> id, MicroservicegroupState? state, CustomResourceOptions? opts = null)
    public static Microservicegroup get(String name, Output<String> id, MicroservicegroupState state, CustomResourceOptions options)
    resources:  _:    type: avi:Microservicegroup    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:
    ConfigpbAttributes List<MicroservicegroupConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CreatedBy string
    Creator name. 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.
    MicroservicegroupId string
    Name string
    Name of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ServiceRefs List<string>
    Configure microservice(es). It is a reference to an object of type microservice. 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.
    Uuid string
    Uuid of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes []MicroservicegroupConfigpbAttributeArgs
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CreatedBy string
    Creator name. 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.
    MicroservicegroupId string
    Name string
    Name of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ServiceRefs []string
    Configure microservice(es). It is a reference to an object of type microservice. 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.
    Uuid string
    Uuid of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<MicroservicegroupConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    createdBy String
    Creator name. 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.
    microservicegroupId String
    name String
    Name of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serviceRefs List<String>
    Configure microservice(es). It is a reference to an object of type microservice. 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.
    uuid String
    Uuid of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes MicroservicegroupConfigpbAttribute[]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    createdBy string
    Creator name. 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.
    microservicegroupId string
    name string
    Name of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serviceRefs string[]
    Configure microservice(es). It is a reference to an object of type microservice. 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.
    uuid string
    Uuid of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpb_attributes Sequence[MicroservicegroupConfigpbAttributeArgs]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    created_by str
    Creator name. 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.
    microservicegroup_id str
    name str
    Name of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    service_refs Sequence[str]
    Configure microservice(es). It is a reference to an object of type microservice. 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.
    uuid str
    Uuid of the microservice group. 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.
    createdBy String
    Creator name. 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.
    microservicegroupId String
    name String
    Name of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serviceRefs List<String>
    Configure microservice(es). It is a reference to an object of type microservice. 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.
    uuid String
    Uuid of the microservice group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

    Supporting Types

    MicroservicegroupConfigpbAttribute, MicroservicegroupConfigpbAttributeArgs

    Version string
    Version string
    version String
    version string
    version 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
    vmware/terraform-provider-avi