1. Packages
  2. Vra Provider
  3. API Docs
  4. getNetworkDomain
vra 0.12.0 published on Monday, Apr 14, 2025 by vmware

vra.getNetworkDomain

Explore with Pulumi AI

vra logo
vra 0.12.0 published on Monday, Apr 14, 2025 by vmware

    Example Usage

    S

    This is an example of how to lookup Network domain objects.

    Network Domain by filter query:

    import * as pulumi from "@pulumi/pulumi";
    import * as vra from "@pulumi/vra";
    
    const _this = vra.getNetworkDomain({
        filter: `name eq '${_var.name}'`,
    });
    
    import pulumi
    import pulumi_vra as vra
    
    this = vra.get_network_domain(filter=f"name eq '{var['name']}'")
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vra/vra"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vra.GetNetworkDomain(ctx, &vra.GetNetworkDomainArgs{
    			Filter: fmt.Sprintf("name eq '%v'", _var.Name),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vra = Pulumi.Vra;
    
    return await Deployment.RunAsync(() => 
    {
        var @this = Vra.GetNetworkDomain.Invoke(new()
        {
            Filter = $"name eq '{@var.Name}'",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vra.VraFunctions;
    import com.pulumi.vra.inputs.GetNetworkDomainArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var this = VraFunctions.getNetworkDomain(GetNetworkDomainArgs.builder()
                .filter(String.format("name eq '%s'", var_.name()))
                .build());
    
        }
    }
    
    variables:
      this:
        fn::invoke:
          function: vra:getNetworkDomain
          arguments:
            filter: name eq '${var.name}'
    

    A network domain object supports the following arguments:

    Using getNetworkDomain

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getNetworkDomain(args: GetNetworkDomainArgs, opts?: InvokeOptions): Promise<GetNetworkDomainResult>
    function getNetworkDomainOutput(args: GetNetworkDomainOutputArgs, opts?: InvokeOptions): Output<GetNetworkDomainResult>
    def get_network_domain(filter: Optional[str] = None,
                           id: Optional[str] = None,
                           tags: Optional[Sequence[GetNetworkDomainTag]] = None,
                           opts: Optional[InvokeOptions] = None) -> GetNetworkDomainResult
    def get_network_domain_output(filter: Optional[pulumi.Input[str]] = None,
                           id: Optional[pulumi.Input[str]] = None,
                           tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetNetworkDomainTagArgs]]]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetNetworkDomainResult]
    func GetNetworkDomain(ctx *Context, args *GetNetworkDomainArgs, opts ...InvokeOption) (*GetNetworkDomainResult, error)
    func GetNetworkDomainOutput(ctx *Context, args *GetNetworkDomainOutputArgs, opts ...InvokeOption) GetNetworkDomainResultOutput

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

    public static class GetNetworkDomain 
    {
        public static Task<GetNetworkDomainResult> InvokeAsync(GetNetworkDomainArgs args, InvokeOptions? opts = null)
        public static Output<GetNetworkDomainResult> Invoke(GetNetworkDomainInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNetworkDomainResult> getNetworkDomain(GetNetworkDomainArgs args, InvokeOptions options)
    public static Output<GetNetworkDomainResult> getNetworkDomain(GetNetworkDomainArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vra:index/getNetworkDomain:getNetworkDomain
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Filter string
    Search criteria to narrow down the network domain objects.
    Id string
    ID of the fabric network domain object.
    Tags List<GetNetworkDomainTag>
    Set of tag keys and values to apply to the resource. Example: [ { "key" : "vmware", "value": "provider" } ]
    Filter string
    Search criteria to narrow down the network domain objects.
    Id string
    ID of the fabric network domain object.
    Tags []GetNetworkDomainTag
    Set of tag keys and values to apply to the resource. Example: [ { "key" : "vmware", "value": "provider" } ]
    filter String
    Search criteria to narrow down the network domain objects.
    id String
    ID of the fabric network domain object.
    tags List<GetNetworkDomainTag>
    Set of tag keys and values to apply to the resource. Example: [ { "key" : "vmware", "value": "provider" } ]
    filter string
    Search criteria to narrow down the network domain objects.
    id string
    ID of the fabric network domain object.
    tags GetNetworkDomainTag[]
    Set of tag keys and values to apply to the resource. Example: [ { "key" : "vmware", "value": "provider" } ]
    filter str
    Search criteria to narrow down the network domain objects.
    id str
    ID of the fabric network domain object.
    tags Sequence[GetNetworkDomainTag]
    Set of tag keys and values to apply to the resource. Example: [ { "key" : "vmware", "value": "provider" } ]
    filter String
    Search criteria to narrow down the network domain objects.
    id String
    ID of the fabric network domain object.
    tags List<Property Map>
    Set of tag keys and values to apply to the resource. Example: [ { "key" : "vmware", "value": "provider" } ]

    getNetworkDomain Result

    The following output properties are available:

    Cidr string
    CloudAccountIds List<string>
    Set of ids of the cloud accounts this entity belongs to.
    CreatedAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    CustomProperties Dictionary<string, string>
    Description string
    A human-friendly description of the fabric vSphere storage account.
    ExternalId string
    External entity Id on the provider side.
    ExternalRegionId string
    The id of the region for which this entity is defined.
    Filter string
    Id string
    ID of the fabric network domain object.
    Links List<GetNetworkDomainLink>
    HATEOAS of the entity
    Name string
    Name of the network domain.
    OrganizationId string
    Owner string
    Email of the user that owns the entity.
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    Tags List<GetNetworkDomainTag>
    Set of tag keys and values to apply to the resource. Example: [ { "key" : "vmware", "value": "provider" } ]
    Cidr string
    CloudAccountIds []string
    Set of ids of the cloud accounts this entity belongs to.
    CreatedAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    CustomProperties map[string]string
    Description string
    A human-friendly description of the fabric vSphere storage account.
    ExternalId string
    External entity Id on the provider side.
    ExternalRegionId string
    The id of the region for which this entity is defined.
    Filter string
    Id string
    ID of the fabric network domain object.
    Links []GetNetworkDomainLink
    HATEOAS of the entity
    Name string
    Name of the network domain.
    OrganizationId string
    Owner string
    Email of the user that owns the entity.
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    Tags []GetNetworkDomainTag
    Set of tag keys and values to apply to the resource. Example: [ { "key" : "vmware", "value": "provider" } ]
    cidr String
    cloudAccountIds List<String>
    Set of ids of the cloud accounts this entity belongs to.
    createdAt String
    Date when the entity was created. The date is in ISO 6801 and UTC.
    customProperties Map<String,String>
    description String
    A human-friendly description of the fabric vSphere storage account.
    externalId String
    External entity Id on the provider side.
    externalRegionId String
    The id of the region for which this entity is defined.
    filter String
    id String
    ID of the fabric network domain object.
    links List<GetNetworkDomainLink>
    HATEOAS of the entity
    name String
    Name of the network domain.
    organizationId String
    owner String
    Email of the user that owns the entity.
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    tags List<GetNetworkDomainTag>
    Set of tag keys and values to apply to the resource. Example: [ { "key" : "vmware", "value": "provider" } ]
    cidr string
    cloudAccountIds string[]
    Set of ids of the cloud accounts this entity belongs to.
    createdAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    customProperties {[key: string]: string}
    description string
    A human-friendly description of the fabric vSphere storage account.
    externalId string
    External entity Id on the provider side.
    externalRegionId string
    The id of the region for which this entity is defined.
    filter string
    id string
    ID of the fabric network domain object.
    links GetNetworkDomainLink[]
    HATEOAS of the entity
    name string
    Name of the network domain.
    organizationId string
    owner string
    Email of the user that owns the entity.
    updatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    tags GetNetworkDomainTag[]
    Set of tag keys and values to apply to the resource. Example: [ { "key" : "vmware", "value": "provider" } ]
    cidr str
    cloud_account_ids Sequence[str]
    Set of ids of the cloud accounts this entity belongs to.
    created_at str
    Date when the entity was created. The date is in ISO 6801 and UTC.
    custom_properties Mapping[str, str]
    description str
    A human-friendly description of the fabric vSphere storage account.
    external_id str
    External entity Id on the provider side.
    external_region_id str
    The id of the region for which this entity is defined.
    filter str
    id str
    ID of the fabric network domain object.
    links Sequence[GetNetworkDomainLink]
    HATEOAS of the entity
    name str
    Name of the network domain.
    organization_id str
    owner str
    Email of the user that owns the entity.
    updated_at str
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    tags Sequence[GetNetworkDomainTag]
    Set of tag keys and values to apply to the resource. Example: [ { "key" : "vmware", "value": "provider" } ]
    cidr String
    cloudAccountIds List<String>
    Set of ids of the cloud accounts this entity belongs to.
    createdAt String
    Date when the entity was created. The date is in ISO 6801 and UTC.
    customProperties Map<String>
    description String
    A human-friendly description of the fabric vSphere storage account.
    externalId String
    External entity Id on the provider side.
    externalRegionId String
    The id of the region for which this entity is defined.
    filter String
    id String
    ID of the fabric network domain object.
    links List<Property Map>
    HATEOAS of the entity
    name String
    Name of the network domain.
    organizationId String
    owner String
    Email of the user that owns the entity.
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    tags List<Property Map>
    Set of tag keys and values to apply to the resource. Example: [ { "key" : "vmware", "value": "provider" } ]

    Supporting Types

    Href string
    Hrefs List<string>
    Rel string
    Href string
    Hrefs []string
    Rel string
    href String
    hrefs List<String>
    rel String
    href string
    hrefs string[]
    rel string
    href str
    hrefs Sequence[str]
    rel str
    href String
    hrefs List<String>
    rel String

    GetNetworkDomainTag

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    Package Details

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