Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. avs
  5. getHcxEnterpriseSite
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.avs.getHcxEnterpriseSite

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a HcxEnterpriseSite

Uses Azure REST API version 2023-09-01.

Other available API versions: 2022-05-01, 2023-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native avs [ApiVersion]. See the version guide for details.

Using getHcxEnterpriseSite

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 getHcxEnterpriseSite(args: GetHcxEnterpriseSiteArgs, opts?: InvokeOptions): Promise<GetHcxEnterpriseSiteResult>
function getHcxEnterpriseSiteOutput(args: GetHcxEnterpriseSiteOutputArgs, opts?: InvokeOptions): Output<GetHcxEnterpriseSiteResult>
Copy
def get_hcx_enterprise_site(hcx_enterprise_site_name: Optional[str] = None,
                            private_cloud_name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetHcxEnterpriseSiteResult
def get_hcx_enterprise_site_output(hcx_enterprise_site_name: Optional[pulumi.Input[str]] = None,
                            private_cloud_name: Optional[pulumi.Input[str]] = None,
                            resource_group_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetHcxEnterpriseSiteResult]
Copy
func LookupHcxEnterpriseSite(ctx *Context, args *LookupHcxEnterpriseSiteArgs, opts ...InvokeOption) (*LookupHcxEnterpriseSiteResult, error)
func LookupHcxEnterpriseSiteOutput(ctx *Context, args *LookupHcxEnterpriseSiteOutputArgs, opts ...InvokeOption) LookupHcxEnterpriseSiteResultOutput
Copy

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

public static class GetHcxEnterpriseSite 
{
    public static Task<GetHcxEnterpriseSiteResult> InvokeAsync(GetHcxEnterpriseSiteArgs args, InvokeOptions? opts = null)
    public static Output<GetHcxEnterpriseSiteResult> Invoke(GetHcxEnterpriseSiteInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetHcxEnterpriseSiteResult> getHcxEnterpriseSite(GetHcxEnterpriseSiteArgs args, InvokeOptions options)
public static Output<GetHcxEnterpriseSiteResult> getHcxEnterpriseSite(GetHcxEnterpriseSiteArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:avs:getHcxEnterpriseSite
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

HcxEnterpriseSiteName
This property is required.
Changes to this property will trigger replacement.
string
Name of the HCX Enterprise Site
PrivateCloudName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private cloud
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
HcxEnterpriseSiteName
This property is required.
Changes to this property will trigger replacement.
string
Name of the HCX Enterprise Site
PrivateCloudName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private cloud
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
hcxEnterpriseSiteName
This property is required.
Changes to this property will trigger replacement.
String
Name of the HCX Enterprise Site
privateCloudName
This property is required.
Changes to this property will trigger replacement.
String
Name of the private cloud
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
hcxEnterpriseSiteName
This property is required.
Changes to this property will trigger replacement.
string
Name of the HCX Enterprise Site
privateCloudName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private cloud
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
hcx_enterprise_site_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the HCX Enterprise Site
private_cloud_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the private cloud
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
hcxEnterpriseSiteName
This property is required.
Changes to this property will trigger replacement.
String
Name of the HCX Enterprise Site
privateCloudName
This property is required.
Changes to this property will trigger replacement.
String
Name of the private cloud
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getHcxEnterpriseSite Result

The following output properties are available:

ActivationKey string
The activation key
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
ProvisioningState string
The provisioning state of the resource.
Status string
The status of the HCX Enterprise Site
SystemData Pulumi.AzureNative.AVS.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ActivationKey string
The activation key
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
ProvisioningState string
The provisioning state of the resource.
Status string
The status of the HCX Enterprise Site
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
activationKey String
The activation key
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
provisioningState String
The provisioning state of the resource.
status String
The status of the HCX Enterprise Site
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
activationKey string
The activation key
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name string
The name of the resource
provisioningState string
The provisioning state of the resource.
status string
The status of the HCX Enterprise Site
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
activation_key str
The activation key
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name str
The name of the resource
provisioning_state str
The provisioning state of the resource.
status str
The status of the HCX Enterprise Site
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
activationKey String
The activation key
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
provisioningState String
The provisioning state of the resource.
status String
The status of the HCX Enterprise Site
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native