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

avi.Controllerportalregistration

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.Controllerportalregistration” sidebar_current: “docs-avi-resource-controllerportalregistration” description: |- Creates and manages Avi ControllerPortalRegistration.

    avi.Controllerportalregistration

    The ControllerPortalRegistration resource allows the creation and management of Avi ControllerPortalRegistration

    Example Usage

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

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

    import pulumi
import pulumi_avi as avi

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

    }
}

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

    Create Controllerportalregistration Resource

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

    Constructor syntax

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

@overload
def Controllerportalregistration(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 assets: Optional[Sequence[ControllerportalregistrationAssetArgs]] = None,
                                 controllerportalregistration_id: Optional[str] = None,
                                 name: Optional[str] = None,
                                 portal_auths: Optional[Sequence[ControllerportalregistrationPortalAuthArgs]] = None,
                                 tenant_ref: Optional[str] = None,
                                 uuid: Optional[str] = None)
    func NewControllerportalregistration(ctx *Context, name string, args *ControllerportalregistrationArgs, opts ...ResourceOption) (*Controllerportalregistration, error)
    public Controllerportalregistration(string name, ControllerportalregistrationArgs? args = null, CustomResourceOptions? opts = null)
    public Controllerportalregistration(String name, ControllerportalregistrationArgs args)
public Controllerportalregistration(String name, ControllerportalregistrationArgs args, CustomResourceOptions options)

    type: avi:Controllerportalregistration
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 ControllerportalregistrationArgs
    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 ControllerportalregistrationArgs
    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 ControllerportalregistrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ControllerportalregistrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ControllerportalregistrationArgs
    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 controllerportalregistrationResource = new Avi.Controllerportalregistration("controllerportalregistrationResource", new()
{
    Assets = new[]
    {
        new Avi.Inputs.ControllerportalregistrationAssetArgs
        {
            AssetId = "string",
        },
    },
    ControllerportalregistrationId = "string",
    Name = "string",
    PortalAuths = new[]
    {
        new Avi.Inputs.ControllerportalregistrationPortalAuthArgs
        {
            AccessToken = "string",
            GrantType = "string",
            InstanceUrl = "string",
            JwtToken = "string",
            Tenant = "string",
        },
    },
    TenantRef = "string",
    Uuid = "string",
});

    example, err := avi.NewControllerportalregistration(ctx, "controllerportalregistrationResource", &avi.ControllerportalregistrationArgs{
	Assets: avi.ControllerportalregistrationAssetArray{
		&avi.ControllerportalregistrationAssetArgs{
			AssetId: pulumi.String("string"),
		},
	},
	ControllerportalregistrationId: pulumi.String("string"),
	Name:                           pulumi.String("string"),
	PortalAuths: avi.ControllerportalregistrationPortalAuthArray{
		&avi.ControllerportalregistrationPortalAuthArgs{
			AccessToken: pulumi.String("string"),
			GrantType:   pulumi.String("string"),
			InstanceUrl: pulumi.String("string"),
			JwtToken:    pulumi.String("string"),
			Tenant:      pulumi.String("string"),
		},
	},
	TenantRef: pulumi.String("string"),
	Uuid:      pulumi.String("string"),
})

    var controllerportalregistrationResource = new Controllerportalregistration("controllerportalregistrationResource", ControllerportalregistrationArgs.builder()
    .assets(ControllerportalregistrationAssetArgs.builder()
        .assetId("string")
        .build())
    .controllerportalregistrationId("string")
    .name("string")
    .portalAuths(ControllerportalregistrationPortalAuthArgs.builder()
        .accessToken("string")
        .grantType("string")
        .instanceUrl("string")
        .jwtToken("string")
        .tenant("string")
        .build())
    .tenantRef("string")
    .uuid("string")
    .build());

    controllerportalregistration_resource = avi.Controllerportalregistration("controllerportalregistrationResource",
    assets=[{
        "asset_id": "string",
    }],
    controllerportalregistration_id="string",
    name="string",
    portal_auths=[{
        "access_token": "string",
        "grant_type": "string",
        "instance_url": "string",
        "jwt_token": "string",
        "tenant": "string",
    }],
    tenant_ref="string",
    uuid="string")

    const controllerportalregistrationResource = new avi.Controllerportalregistration("controllerportalregistrationResource", {
    assets: [{
        assetId: "string",
    }],
    controllerportalregistrationId: "string",
    name: "string",
    portalAuths: [{
        accessToken: "string",
        grantType: "string",
        instanceUrl: "string",
        jwtToken: "string",
        tenant: "string",
    }],
    tenantRef: "string",
    uuid: "string",
});

    type: avi:Controllerportalregistration
properties:
    assets:
        - assetId: string
    controllerportalregistrationId: string
    name: string
    portalAuths:
        - accessToken: string
          grantType: string
          instanceUrl: string
          jwtToken: string
          tenant: string
    tenantRef: string
    uuid: string

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

    Assets List<ControllerportalregistrationAsset>
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ControllerportalregistrationId string
    Name string
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PortalAuths List<ControllerportalregistrationPortalAuth>
    Field introduced in 18.2.6. 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. Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Assets []ControllerportalregistrationAssetArgs
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ControllerportalregistrationId string
    Name string
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PortalAuths []ControllerportalregistrationPortalAuthArgs
    Field introduced in 18.2.6. 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. Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    assets List<ControllerportalregistrationAsset>
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    controllerportalregistrationId String
    name String
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    portalAuths List<ControllerportalregistrationPortalAuth>
    Field introduced in 18.2.6. 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. Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    assets ControllerportalregistrationAsset[]
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    controllerportalregistrationId string
    name string
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    portalAuths ControllerportalregistrationPortalAuth[]
    Field introduced in 18.2.6. 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. Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    assets Sequence[ControllerportalregistrationAssetArgs]
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    controllerportalregistration_id str
    name str
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    portal_auths Sequence[ControllerportalregistrationPortalAuthArgs]
    Field introduced in 18.2.6. 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. Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid str
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    assets List<Property Map>
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    controllerportalregistrationId String
    name String
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    portalAuths List<Property Map>
    Field introduced in 18.2.6. 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. Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Field introduced in 18.2.6. 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 Controllerportalregistration 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 Controllerportalregistration Resource

    Get an existing Controllerportalregistration 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?: ControllerportalregistrationState, opts?: CustomResourceOptions): Controllerportalregistration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        assets: Optional[Sequence[ControllerportalregistrationAssetArgs]] = None,
        controllerportalregistration_id: Optional[str] = None,
        name: Optional[str] = None,
        portal_auths: Optional[Sequence[ControllerportalregistrationPortalAuthArgs]] = None,
        tenant_ref: Optional[str] = None,
        uuid: Optional[str] = None) -> Controllerportalregistration
    func GetControllerportalregistration(ctx *Context, name string, id IDInput, state *ControllerportalregistrationState, opts ...ResourceOption) (*Controllerportalregistration, error)
    public static Controllerportalregistration Get(string name, Input<string> id, ControllerportalregistrationState? state, CustomResourceOptions? opts = null)
    public static Controllerportalregistration get(String name, Output<String> id, ControllerportalregistrationState state, CustomResourceOptions options)
    resources:  _:    type: avi:Controllerportalregistration    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:
    Assets List<ControllerportalregistrationAsset>
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ControllerportalregistrationId string
    Name string
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PortalAuths List<ControllerportalregistrationPortalAuth>
    Field introduced in 18.2.6. 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. Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Assets []ControllerportalregistrationAssetArgs
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ControllerportalregistrationId string
    Name string
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PortalAuths []ControllerportalregistrationPortalAuthArgs
    Field introduced in 18.2.6. 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. Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    assets List<ControllerportalregistrationAsset>
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    controllerportalregistrationId String
    name String
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    portalAuths List<ControllerportalregistrationPortalAuth>
    Field introduced in 18.2.6. 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. Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    assets ControllerportalregistrationAsset[]
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    controllerportalregistrationId string
    name string
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    portalAuths ControllerportalregistrationPortalAuth[]
    Field introduced in 18.2.6. 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. Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    assets Sequence[ControllerportalregistrationAssetArgs]
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    controllerportalregistration_id str
    name str
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    portal_auths Sequence[ControllerportalregistrationPortalAuthArgs]
    Field introduced in 18.2.6. 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. Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid str
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    assets List<Property Map>
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    controllerportalregistrationId String
    name String
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    portalAuths List<Property Map>
    Field introduced in 18.2.6. 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. Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Field introduced in 18.2.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

    Supporting Types

    ControllerportalregistrationAsset, ControllerportalregistrationAssetArgs

    AssetId string
    AssetId string
    assetId String
    assetId string
    assetId String

    ControllerportalregistrationPortalAuth, ControllerportalregistrationPortalAuthArgs

    AccessToken string
    GrantType string
    InstanceUrl string
    JwtToken string
    Tenant string
    AccessToken string
    GrantType string
    InstanceUrl string
    JwtToken string
    Tenant string
    accessToken String
    grantType String
    instanceUrl String
    jwtToken String
    tenant String
    accessToken string
    grantType string
    instanceUrl string
    jwtToken string
    tenant string
    accessToken String
    grantType String
    instanceUrl String
    jwtToken String
    tenant 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