Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. avs
  5. getPrivateCloud
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.avs.getPrivateCloud

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    A private cloud resource API Version: 2020-03-20.

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

    > 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)
}
    public static CompletableFuture<GetPrivateCloudResult> getPrivateCloud(GetPrivateCloudArgs args, InvokeOptions options)
public static Output<GetPrivateCloudResult> getPrivateCloud(GetPrivateCloudArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:avs:getPrivateCloud
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PrivateCloudName string
    Name of the private cloud
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    PrivateCloudName string
    Name of the private cloud
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    privateCloudName String
    Name of the private cloud
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    privateCloudName string
    Name of the private cloud
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    private_cloud_name str
    Name of the private cloud
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    privateCloudName String
    Name of the private cloud
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getPrivateCloud Result

    The following output properties are available:

    Endpoints Pulumi.AzureNative.AVS.Outputs.EndpointsResponse
    The endpoints
    Id string
    Resource ID.
    Location string
    Resource location
    ManagementCluster Pulumi.AzureNative.AVS.Outputs.ManagementClusterResponse
    The default cluster used for management
    ManagementNetwork string
    Network used to access vCenter Server and NSX-T Manager
    Name string
    Resource name.
    NetworkBlock string
    The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22
    NsxtCertificateThumbprint string
    Thumbprint of the NSX-T Manager SSL certificate
    ProvisioningNetwork string
    Used for virtual machine cold migration, cloning, and snapshot migration
    ProvisioningState string
    The provisioning state
    Sku Pulumi.AzureNative.AVS.Outputs.SkuResponse
    The private cloud SKU
    Type string
    Resource type.
    VcenterCertificateThumbprint string
    Thumbprint of the vCenter Server SSL certificate
    VmotionNetwork string
    Used for live migration of virtual machines
    Circuit Pulumi.AzureNative.AVS.Outputs.CircuitResponse
    An ExpressRoute Circuit
    IdentitySources List<Pulumi.AzureNative.AVS.Outputs.IdentitySourceResponse>
    vCenter Single Sign On Identity Sources
    Internet string
    Connectivity to internet is enabled or disabled
    NsxtPassword string
    Optionally, set the NSX-T Manager password when the private cloud is created
    Tags Dictionary<string, string>
    Resource tags
    VcenterPassword string
    Optionally, set the vCenter admin password when the private cloud is created
    Endpoints EndpointsResponse
    The endpoints
    Id string
    Resource ID.
    Location string
    Resource location
    ManagementCluster ManagementClusterResponse
    The default cluster used for management
    ManagementNetwork string
    Network used to access vCenter Server and NSX-T Manager
    Name string
    Resource name.
    NetworkBlock string
    The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22
    NsxtCertificateThumbprint string
    Thumbprint of the NSX-T Manager SSL certificate
    ProvisioningNetwork string
    Used for virtual machine cold migration, cloning, and snapshot migration
    ProvisioningState string
    The provisioning state
    Sku SkuResponse
    The private cloud SKU
    Type string
    Resource type.
    VcenterCertificateThumbprint string
    Thumbprint of the vCenter Server SSL certificate
    VmotionNetwork string
    Used for live migration of virtual machines
    Circuit CircuitResponse
    An ExpressRoute Circuit
    IdentitySources []IdentitySourceResponse
    vCenter Single Sign On Identity Sources
    Internet string
    Connectivity to internet is enabled or disabled
    NsxtPassword string
    Optionally, set the NSX-T Manager password when the private cloud is created
    Tags map[string]string
    Resource tags
    VcenterPassword string
    Optionally, set the vCenter admin password when the private cloud is created
    endpoints EndpointsResponse
    The endpoints
    id String
    Resource ID.
    location String
    Resource location
    managementCluster ManagementClusterResponse
    The default cluster used for management
    managementNetwork String
    Network used to access vCenter Server and NSX-T Manager
    name String
    Resource name.
    networkBlock String
    The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22
    nsxtCertificateThumbprint String
    Thumbprint of the NSX-T Manager SSL certificate
    provisioningNetwork String
    Used for virtual machine cold migration, cloning, and snapshot migration
    provisioningState String
    The provisioning state
    sku SkuResponse
    The private cloud SKU
    type String
    Resource type.
    vcenterCertificateThumbprint String
    Thumbprint of the vCenter Server SSL certificate
    vmotionNetwork String
    Used for live migration of virtual machines
    circuit CircuitResponse
    An ExpressRoute Circuit
    identitySources List<IdentitySourceResponse>
    vCenter Single Sign On Identity Sources
    internet String
    Connectivity to internet is enabled or disabled
    nsxtPassword String
    Optionally, set the NSX-T Manager password when the private cloud is created
    tags Map<String,String>
    Resource tags
    vcenterPassword String
    Optionally, set the vCenter admin password when the private cloud is created
    endpoints EndpointsResponse
    The endpoints
    id string
    Resource ID.
    location string
    Resource location
    managementCluster ManagementClusterResponse
    The default cluster used for management
    managementNetwork string
    Network used to access vCenter Server and NSX-T Manager
    name string
    Resource name.
    networkBlock string
    The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22
    nsxtCertificateThumbprint string
    Thumbprint of the NSX-T Manager SSL certificate
    provisioningNetwork string
    Used for virtual machine cold migration, cloning, and snapshot migration
    provisioningState string
    The provisioning state
    sku SkuResponse
    The private cloud SKU
    type string
    Resource type.
    vcenterCertificateThumbprint string
    Thumbprint of the vCenter Server SSL certificate
    vmotionNetwork string
    Used for live migration of virtual machines
    circuit CircuitResponse
    An ExpressRoute Circuit
    identitySources IdentitySourceResponse[]
    vCenter Single Sign On Identity Sources
    internet string
    Connectivity to internet is enabled or disabled
    nsxtPassword string
    Optionally, set the NSX-T Manager password when the private cloud is created
    tags {[key: string]: string}
    Resource tags
    vcenterPassword string
    Optionally, set the vCenter admin password when the private cloud is created
    endpoints EndpointsResponse
    The endpoints
    id str
    Resource ID.
    location str
    Resource location
    management_cluster ManagementClusterResponse
    The default cluster used for management
    management_network str
    Network used to access vCenter Server and NSX-T Manager
    name str
    Resource name.
    network_block str
    The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22
    nsxt_certificate_thumbprint str
    Thumbprint of the NSX-T Manager SSL certificate
    provisioning_network str
    Used for virtual machine cold migration, cloning, and snapshot migration
    provisioning_state str
    The provisioning state
    sku SkuResponse
    The private cloud SKU
    type str
    Resource type.
    vcenter_certificate_thumbprint str
    Thumbprint of the vCenter Server SSL certificate
    vmotion_network str
    Used for live migration of virtual machines
    circuit CircuitResponse
    An ExpressRoute Circuit
    identity_sources Sequence[IdentitySourceResponse]
    vCenter Single Sign On Identity Sources
    internet str
    Connectivity to internet is enabled or disabled
    nsxt_password str
    Optionally, set the NSX-T Manager password when the private cloud is created
    tags Mapping[str, str]
    Resource tags
    vcenter_password str
    Optionally, set the vCenter admin password when the private cloud is created
    endpoints Property Map
    The endpoints
    id String
    Resource ID.
    location String
    Resource location
    managementCluster Property Map
    The default cluster used for management
    managementNetwork String
    Network used to access vCenter Server and NSX-T Manager
    name String
    Resource name.
    networkBlock String
    The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22
    nsxtCertificateThumbprint String
    Thumbprint of the NSX-T Manager SSL certificate
    provisioningNetwork String
    Used for virtual machine cold migration, cloning, and snapshot migration
    provisioningState String
    The provisioning state
    sku Property Map
    The private cloud SKU
    type String
    Resource type.
    vcenterCertificateThumbprint String
    Thumbprint of the vCenter Server SSL certificate
    vmotionNetwork String
    Used for live migration of virtual machines
    circuit Property Map
    An ExpressRoute Circuit
    identitySources List<Property Map>
    vCenter Single Sign On Identity Sources
    internet String
    Connectivity to internet is enabled or disabled
    nsxtPassword String
    Optionally, set the NSX-T Manager password when the private cloud is created
    tags Map<String>
    Resource tags
    vcenterPassword String
    Optionally, set the vCenter admin password when the private cloud is created

    Supporting Types

    CircuitResponse

    ExpressRouteID string
    Identifier of the ExpressRoute Circuit (Microsoft Colo only)
    ExpressRoutePrivatePeeringID string
    ExpressRoute Circuit private peering identifier
    PrimarySubnet string
    CIDR of primary subnet
    SecondarySubnet string
    CIDR of secondary subnet
    ExpressRouteID string
    Identifier of the ExpressRoute Circuit (Microsoft Colo only)
    ExpressRoutePrivatePeeringID string
    ExpressRoute Circuit private peering identifier
    PrimarySubnet string
    CIDR of primary subnet
    SecondarySubnet string
    CIDR of secondary subnet
    expressRouteID String
    Identifier of the ExpressRoute Circuit (Microsoft Colo only)
    expressRoutePrivatePeeringID String
    ExpressRoute Circuit private peering identifier
    primarySubnet String
    CIDR of primary subnet
    secondarySubnet String
    CIDR of secondary subnet
    expressRouteID string
    Identifier of the ExpressRoute Circuit (Microsoft Colo only)
    expressRoutePrivatePeeringID string
    ExpressRoute Circuit private peering identifier
    primarySubnet string
    CIDR of primary subnet
    secondarySubnet string
    CIDR of secondary subnet
    express_route_id str
    Identifier of the ExpressRoute Circuit (Microsoft Colo only)
    express_route_private_peering_id str
    ExpressRoute Circuit private peering identifier
    primary_subnet str
    CIDR of primary subnet
    secondary_subnet str
    CIDR of secondary subnet
    expressRouteID String
    Identifier of the ExpressRoute Circuit (Microsoft Colo only)
    expressRoutePrivatePeeringID String
    ExpressRoute Circuit private peering identifier
    primarySubnet String
    CIDR of primary subnet
    secondarySubnet String
    CIDR of secondary subnet

    EndpointsResponse

    HcxCloudManager string
    Endpoint for the HCX Cloud Manager
    NsxtManager string
    Endpoint for the NSX-T Data Center manager
    Vcsa string
    Endpoint for Virtual Center Server Appliance
    HcxCloudManager string
    Endpoint for the HCX Cloud Manager
    NsxtManager string
    Endpoint for the NSX-T Data Center manager
    Vcsa string
    Endpoint for Virtual Center Server Appliance
    hcxCloudManager String
    Endpoint for the HCX Cloud Manager
    nsxtManager String
    Endpoint for the NSX-T Data Center manager
    vcsa String
    Endpoint for Virtual Center Server Appliance
    hcxCloudManager string
    Endpoint for the HCX Cloud Manager
    nsxtManager string
    Endpoint for the NSX-T Data Center manager
    vcsa string
    Endpoint for Virtual Center Server Appliance
    hcx_cloud_manager str
    Endpoint for the HCX Cloud Manager
    nsxt_manager str
    Endpoint for the NSX-T Data Center manager
    vcsa str
    Endpoint for Virtual Center Server Appliance
    hcxCloudManager String
    Endpoint for the HCX Cloud Manager
    nsxtManager String
    Endpoint for the NSX-T Data Center manager
    vcsa String
    Endpoint for Virtual Center Server Appliance

    IdentitySourceResponse

    Alias string
    The domain's NetBIOS name
    BaseGroupDN string
    The base distinguished name for groups
    BaseUserDN string
    The base distinguished name for users
    Domain string
    The domain's dns name
    Name string
    The name of the identity source
    Password string
    The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups.
    PrimaryServer string
    Primary server URL
    SecondaryServer string
    Secondary server URL
    Ssl string
    Protect LDAP communication using SSL certificate (LDAPS)
    Username string
    The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group
    Alias string
    The domain's NetBIOS name
    BaseGroupDN string
    The base distinguished name for groups
    BaseUserDN string
    The base distinguished name for users
    Domain string
    The domain's dns name
    Name string
    The name of the identity source
    Password string
    The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups.
    PrimaryServer string
    Primary server URL
    SecondaryServer string
    Secondary server URL
    Ssl string
    Protect LDAP communication using SSL certificate (LDAPS)
    Username string
    The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group
    alias String
    The domain's NetBIOS name
    baseGroupDN String
    The base distinguished name for groups
    baseUserDN String
    The base distinguished name for users
    domain String
    The domain's dns name
    name String
    The name of the identity source
    password String
    The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups.
    primaryServer String
    Primary server URL
    secondaryServer String
    Secondary server URL
    ssl String
    Protect LDAP communication using SSL certificate (LDAPS)
    username String
    The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group
    alias string
    The domain's NetBIOS name
    baseGroupDN string
    The base distinguished name for groups
    baseUserDN string
    The base distinguished name for users
    domain string
    The domain's dns name
    name string
    The name of the identity source
    password string
    The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups.
    primaryServer string
    Primary server URL
    secondaryServer string
    Secondary server URL
    ssl string
    Protect LDAP communication using SSL certificate (LDAPS)
    username string
    The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group
    alias str
    The domain's NetBIOS name
    base_group_dn str
    The base distinguished name for groups
    base_user_dn str
    The base distinguished name for users
    domain str
    The domain's dns name
    name str
    The name of the identity source
    password str
    The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups.
    primary_server str
    Primary server URL
    secondary_server str
    Secondary server URL
    ssl str
    Protect LDAP communication using SSL certificate (LDAPS)
    username str
    The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group
    alias String
    The domain's NetBIOS name
    baseGroupDN String
    The base distinguished name for groups
    baseUserDN String
    The base distinguished name for users
    domain String
    The domain's dns name
    name String
    The name of the identity source
    password String
    The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups.
    primaryServer String
    Primary server URL
    secondaryServer String
    Secondary server URL
    ssl String
    Protect LDAP communication using SSL certificate (LDAPS)
    username String
    The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group

    ManagementClusterResponse

    ClusterId int
    The identity
    ClusterSize int
    The cluster size
    Hosts List<string>
    The hosts
    ProvisioningState string
    The state of the cluster provisioning
    ClusterId int
    The identity
    ClusterSize int
    The cluster size
    Hosts []string
    The hosts
    ProvisioningState string
    The state of the cluster provisioning
    clusterId Integer
    The identity
    clusterSize Integer
    The cluster size
    hosts List<String>
    The hosts
    provisioningState String
    The state of the cluster provisioning
    clusterId number
    The identity
    clusterSize number
    The cluster size
    hosts string[]
    The hosts
    provisioningState string
    The state of the cluster provisioning
    cluster_id int
    The identity
    cluster_size int
    The cluster size
    hosts Sequence[str]
    The hosts
    provisioning_state str
    The state of the cluster provisioning
    clusterId Number
    The identity
    clusterSize Number
    The cluster size
    hosts List<String>
    The hosts
    provisioningState String
    The state of the cluster provisioning

    SkuResponse

    Name string
    The name of the SKU.
    Name string
    The name of the SKU.
    name String
    The name of the SKU.
    name string
    The name of the SKU.
    name str
    The name of the SKU.
    name String
    The name of the SKU.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native