Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. avs
  5. getPrivateCloud

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.avs.getPrivateCloud

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Use this data source to access information about an existing Azure VMware Solution Private Cloud.

Example Usage

NOTE : Normal pulumi up could ignore this note. Please disable correlation request id for continuous operations in one build (like acctest). The continuous operations like update or delete could not be triggered when it shares the same correlation-id with its previous operation.

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

const example = azure.avs.getPrivateCloud({
    name: "existing-vmware-private-cloud",
    resourceGroupName: "existing-resgroup",
});
export const id = example.then(example => example.id);
Copy
import pulumi
import pulumi_azure as azure

example = azure.avs.get_private_cloud(name="existing-vmware-private-cloud",
    resource_group_name="existing-resgroup")
pulumi.export("id", example.id)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/avs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := avs.LookupPrivateCloud(ctx, &avs.LookupPrivateCloudArgs{
			Name:              "existing-vmware-private-cloud",
			ResourceGroupName: "existing-resgroup",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", example.Id)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.Avs.GetPrivateCloud.Invoke(new()
    {
        Name = "existing-vmware-private-cloud",
        ResourceGroupName = "existing-resgroup",
    });

    return new Dictionary<string, object?>
    {
        ["id"] = example.Apply(getPrivateCloudResult => getPrivateCloudResult.Id),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.avs.AvsFunctions;
import com.pulumi.azure.avs.inputs.GetPrivateCloudArgs;
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 example = AvsFunctions.getPrivateCloud(GetPrivateCloudArgs.builder()
            .name("existing-vmware-private-cloud")
            .resourceGroupName("existing-resgroup")
            .build());

        ctx.export("id", example.applyValue(getPrivateCloudResult -> getPrivateCloudResult.id()));
    }
}
Copy
variables:
  example:
    fn::invoke:
      function: azure:avs:getPrivateCloud
      arguments:
        name: existing-vmware-private-cloud
        resourceGroupName: existing-resgroup
outputs:
  id: ${example.id}
Copy

Using getPrivateCloud

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 getPrivateCloud(args: GetPrivateCloudArgs, opts?: InvokeOptions): Promise<GetPrivateCloudResult>
function getPrivateCloudOutput(args: GetPrivateCloudOutputArgs, opts?: InvokeOptions): Output<GetPrivateCloudResult>
Copy
def get_private_cloud(name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetPrivateCloudResult
def get_private_cloud_output(name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetPrivateCloudResult]
Copy
func LookupPrivateCloud(ctx *Context, args *LookupPrivateCloudArgs, opts ...InvokeOption) (*LookupPrivateCloudResult, error)
func LookupPrivateCloudOutput(ctx *Context, args *LookupPrivateCloudOutputArgs, opts ...InvokeOption) LookupPrivateCloudResultOutput
Copy

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

public static class GetPrivateCloud 
{
    public static Task<GetPrivateCloudResult> InvokeAsync(GetPrivateCloudArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateCloudResult> Invoke(GetPrivateCloudInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPrivateCloudResult> getPrivateCloud(GetPrivateCloudArgs args, InvokeOptions options)
public static Output<GetPrivateCloudResult> getPrivateCloud(GetPrivateCloudArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure:avs/getPrivateCloud:getPrivateCloud
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The name of this Azure VMware Solution Private Cloud.
ResourceGroupName This property is required. string
The name of the Resource Group where the Azure VMware Solution Private Cloud exists.
Name This property is required. string
The name of this Azure VMware Solution Private Cloud.
ResourceGroupName This property is required. string
The name of the Resource Group where the Azure VMware Solution Private Cloud exists.
name This property is required. String
The name of this Azure VMware Solution Private Cloud.
resourceGroupName This property is required. String
The name of the Resource Group where the Azure VMware Solution Private Cloud exists.
name This property is required. string
The name of this Azure VMware Solution Private Cloud.
resourceGroupName This property is required. string
The name of the Resource Group where the Azure VMware Solution Private Cloud exists.
name This property is required. str
The name of this Azure VMware Solution Private Cloud.
resource_group_name This property is required. str
The name of the Resource Group where the Azure VMware Solution Private Cloud exists.
name This property is required. String
The name of this Azure VMware Solution Private Cloud.
resourceGroupName This property is required. String
The name of the Resource Group where the Azure VMware Solution Private Cloud exists.

getPrivateCloud Result

The following output properties are available:

Circuits List<GetPrivateCloudCircuit>
A circuit block as defined below.
HcxCloudManagerEndpoint string
The endpoint for the VMware HCX Cloud Manager.
Id string
The provider-assigned unique ID for this managed resource.
InternetConnectionEnabled bool
Is the Azure VMware Solution Private Cloud connected to the internet?
Location string
The Azure Region where the Azure VMware Solution Private Cloud exists.
ManagementClusters List<GetPrivateCloudManagementCluster>
A management_cluster block as defined below.
ManagementSubnetCidr string
The network used to access VMware vCenter Server and NSX Manager.
Name string
NetworkSubnetCidr string
The subnet CIDR of the Azure VMware Solution Private Cloud.
NsxtCertificateThumbprint string
The thumbprint of the VMware NSX Manager SSL certificate.
NsxtManagerEndpoint string
The endpoint for the VMware NSX Manager.
ProvisioningSubnetCidr string
The network which isused for virtual machine cold migration, cloning, and snapshot migration.
ResourceGroupName string
SkuName string
The Name of the SKU used for this Azure VMware Solution Private Cloud.
Tags Dictionary<string, string>
A mapping of tags assigned to the Azure VMware Solution Private Cloud.
VcenterCertificateThumbprint string
The thumbprint of the VMware vCenter Server SSL certificate.
VcsaEndpoint string
The endpoint for VMware vCenter Server Appliance.
VmotionSubnetCidr string
The network which is used for live migration of virtual machines.
Circuits []GetPrivateCloudCircuit
A circuit block as defined below.
HcxCloudManagerEndpoint string
The endpoint for the VMware HCX Cloud Manager.
Id string
The provider-assigned unique ID for this managed resource.
InternetConnectionEnabled bool
Is the Azure VMware Solution Private Cloud connected to the internet?
Location string
The Azure Region where the Azure VMware Solution Private Cloud exists.
ManagementClusters []GetPrivateCloudManagementCluster
A management_cluster block as defined below.
ManagementSubnetCidr string
The network used to access VMware vCenter Server and NSX Manager.
Name string
NetworkSubnetCidr string
The subnet CIDR of the Azure VMware Solution Private Cloud.
NsxtCertificateThumbprint string
The thumbprint of the VMware NSX Manager SSL certificate.
NsxtManagerEndpoint string
The endpoint for the VMware NSX Manager.
ProvisioningSubnetCidr string
The network which isused for virtual machine cold migration, cloning, and snapshot migration.
ResourceGroupName string
SkuName string
The Name of the SKU used for this Azure VMware Solution Private Cloud.
Tags map[string]string
A mapping of tags assigned to the Azure VMware Solution Private Cloud.
VcenterCertificateThumbprint string
The thumbprint of the VMware vCenter Server SSL certificate.
VcsaEndpoint string
The endpoint for VMware vCenter Server Appliance.
VmotionSubnetCidr string
The network which is used for live migration of virtual machines.
circuits List<GetPrivateCloudCircuit>
A circuit block as defined below.
hcxCloudManagerEndpoint String
The endpoint for the VMware HCX Cloud Manager.
id String
The provider-assigned unique ID for this managed resource.
internetConnectionEnabled Boolean
Is the Azure VMware Solution Private Cloud connected to the internet?
location String
The Azure Region where the Azure VMware Solution Private Cloud exists.
managementClusters List<GetPrivateCloudManagementCluster>
A management_cluster block as defined below.
managementSubnetCidr String
The network used to access VMware vCenter Server and NSX Manager.
name String
networkSubnetCidr String
The subnet CIDR of the Azure VMware Solution Private Cloud.
nsxtCertificateThumbprint String
The thumbprint of the VMware NSX Manager SSL certificate.
nsxtManagerEndpoint String
The endpoint for the VMware NSX Manager.
provisioningSubnetCidr String
The network which isused for virtual machine cold migration, cloning, and snapshot migration.
resourceGroupName String
skuName String
The Name of the SKU used for this Azure VMware Solution Private Cloud.
tags Map<String,String>
A mapping of tags assigned to the Azure VMware Solution Private Cloud.
vcenterCertificateThumbprint String
The thumbprint of the VMware vCenter Server SSL certificate.
vcsaEndpoint String
The endpoint for VMware vCenter Server Appliance.
vmotionSubnetCidr String
The network which is used for live migration of virtual machines.
circuits GetPrivateCloudCircuit[]
A circuit block as defined below.
hcxCloudManagerEndpoint string
The endpoint for the VMware HCX Cloud Manager.
id string
The provider-assigned unique ID for this managed resource.
internetConnectionEnabled boolean
Is the Azure VMware Solution Private Cloud connected to the internet?
location string
The Azure Region where the Azure VMware Solution Private Cloud exists.
managementClusters GetPrivateCloudManagementCluster[]
A management_cluster block as defined below.
managementSubnetCidr string
The network used to access VMware vCenter Server and NSX Manager.
name string
networkSubnetCidr string
The subnet CIDR of the Azure VMware Solution Private Cloud.
nsxtCertificateThumbprint string
The thumbprint of the VMware NSX Manager SSL certificate.
nsxtManagerEndpoint string
The endpoint for the VMware NSX Manager.
provisioningSubnetCidr string
The network which isused for virtual machine cold migration, cloning, and snapshot migration.
resourceGroupName string
skuName string
The Name of the SKU used for this Azure VMware Solution Private Cloud.
tags {[key: string]: string}
A mapping of tags assigned to the Azure VMware Solution Private Cloud.
vcenterCertificateThumbprint string
The thumbprint of the VMware vCenter Server SSL certificate.
vcsaEndpoint string
The endpoint for VMware vCenter Server Appliance.
vmotionSubnetCidr string
The network which is used for live migration of virtual machines.
circuits Sequence[GetPrivateCloudCircuit]
A circuit block as defined below.
hcx_cloud_manager_endpoint str
The endpoint for the VMware HCX Cloud Manager.
id str
The provider-assigned unique ID for this managed resource.
internet_connection_enabled bool
Is the Azure VMware Solution Private Cloud connected to the internet?
location str
The Azure Region where the Azure VMware Solution Private Cloud exists.
management_clusters Sequence[GetPrivateCloudManagementCluster]
A management_cluster block as defined below.
management_subnet_cidr str
The network used to access VMware vCenter Server and NSX Manager.
name str
network_subnet_cidr str
The subnet CIDR of the Azure VMware Solution Private Cloud.
nsxt_certificate_thumbprint str
The thumbprint of the VMware NSX Manager SSL certificate.
nsxt_manager_endpoint str
The endpoint for the VMware NSX Manager.
provisioning_subnet_cidr str
The network which isused for virtual machine cold migration, cloning, and snapshot migration.
resource_group_name str
sku_name str
The Name of the SKU used for this Azure VMware Solution Private Cloud.
tags Mapping[str, str]
A mapping of tags assigned to the Azure VMware Solution Private Cloud.
vcenter_certificate_thumbprint str
The thumbprint of the VMware vCenter Server SSL certificate.
vcsa_endpoint str
The endpoint for VMware vCenter Server Appliance.
vmotion_subnet_cidr str
The network which is used for live migration of virtual machines.
circuits List<Property Map>
A circuit block as defined below.
hcxCloudManagerEndpoint String
The endpoint for the VMware HCX Cloud Manager.
id String
The provider-assigned unique ID for this managed resource.
internetConnectionEnabled Boolean
Is the Azure VMware Solution Private Cloud connected to the internet?
location String
The Azure Region where the Azure VMware Solution Private Cloud exists.
managementClusters List<Property Map>
A management_cluster block as defined below.
managementSubnetCidr String
The network used to access VMware vCenter Server and NSX Manager.
name String
networkSubnetCidr String
The subnet CIDR of the Azure VMware Solution Private Cloud.
nsxtCertificateThumbprint String
The thumbprint of the VMware NSX Manager SSL certificate.
nsxtManagerEndpoint String
The endpoint for the VMware NSX Manager.
provisioningSubnetCidr String
The network which isused for virtual machine cold migration, cloning, and snapshot migration.
resourceGroupName String
skuName String
The Name of the SKU used for this Azure VMware Solution Private Cloud.
tags Map<String>
A mapping of tags assigned to the Azure VMware Solution Private Cloud.
vcenterCertificateThumbprint String
The thumbprint of the VMware vCenter Server SSL certificate.
vcsaEndpoint String
The endpoint for VMware vCenter Server Appliance.
vmotionSubnetCidr String
The network which is used for live migration of virtual machines.

Supporting Types

GetPrivateCloudCircuit

ExpressRouteId This property is required. string
The ID of the ExpressRoute Circuit.
ExpressRoutePrivatePeeringId This property is required. string
The ID of the ExpressRoute Circuit private peering.
PrimarySubnetCidr This property is required. string
The CIDR of the primary subnet.
SecondarySubnetCidr This property is required. string
The CIDR of the secondary subnet.
ExpressRouteId This property is required. string
The ID of the ExpressRoute Circuit.
ExpressRoutePrivatePeeringId This property is required. string
The ID of the ExpressRoute Circuit private peering.
PrimarySubnetCidr This property is required. string
The CIDR of the primary subnet.
SecondarySubnetCidr This property is required. string
The CIDR of the secondary subnet.
expressRouteId This property is required. String
The ID of the ExpressRoute Circuit.
expressRoutePrivatePeeringId This property is required. String
The ID of the ExpressRoute Circuit private peering.
primarySubnetCidr This property is required. String
The CIDR of the primary subnet.
secondarySubnetCidr This property is required. String
The CIDR of the secondary subnet.
expressRouteId This property is required. string
The ID of the ExpressRoute Circuit.
expressRoutePrivatePeeringId This property is required. string
The ID of the ExpressRoute Circuit private peering.
primarySubnetCidr This property is required. string
The CIDR of the primary subnet.
secondarySubnetCidr This property is required. string
The CIDR of the secondary subnet.
express_route_id This property is required. str
The ID of the ExpressRoute Circuit.
express_route_private_peering_id This property is required. str
The ID of the ExpressRoute Circuit private peering.
primary_subnet_cidr This property is required. str
The CIDR of the primary subnet.
secondary_subnet_cidr This property is required. str
The CIDR of the secondary subnet.
expressRouteId This property is required. String
The ID of the ExpressRoute Circuit.
expressRoutePrivatePeeringId This property is required. String
The ID of the ExpressRoute Circuit private peering.
primarySubnetCidr This property is required. String
The CIDR of the primary subnet.
secondarySubnetCidr This property is required. String
The CIDR of the secondary subnet.

GetPrivateCloudManagementCluster

Hosts This property is required. List<string>
The list of the hosts in the management cluster.
Id This property is required. int
The ID of the management cluster.
Size This property is required. int
The size of the management cluster.
Hosts This property is required. []string
The list of the hosts in the management cluster.
Id This property is required. int
The ID of the management cluster.
Size This property is required. int
The size of the management cluster.
hosts This property is required. List<String>
The list of the hosts in the management cluster.
id This property is required. Integer
The ID of the management cluster.
size This property is required. Integer
The size of the management cluster.
hosts This property is required. string[]
The list of the hosts in the management cluster.
id This property is required. number
The ID of the management cluster.
size This property is required. number
The size of the management cluster.
hosts This property is required. Sequence[str]
The list of the hosts in the management cluster.
id This property is required. int
The ID of the management cluster.
size This property is required. int
The size of the management cluster.
hosts This property is required. List<String>
The list of the hosts in the management cluster.
id This property is required. Number
The ID of the management cluster.
size This property is required. Number
The size of the management cluster.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure